A basic REST-API for a chat application using Spring.
NOTE: THIS PROJECT HAS BEEN PUT ON-HOLD.
NOTE: As this project was mainly used for learning purposes, it has private api keys / tokens exposed and does not include any tests (yet).
- API that creates basis for a chat platform consisting of multiple users that can start conversations (either direct conversations or group conversations) and exchange messages
- Full CRUD-Operations supported (see Endpoints)
- User data securely stored and encrypted in database
- Integration of Spring-Security:
- Basic authentication by username (email) and password
- JWT Token authentication for stateless access without needing to provide the credentials in every request
(The use of tools such as POSTMAN is highly recommended)
-
username:
admin -
password:
password
POST/http://localhost:8080/api/token with basic authentication using the above credentials.
You can now access the API as an admin using the provided JWT-Token as Bearer Token.
To access the database go to http://localhost:8080/h2-console/.
To access the API go to http://localhost:8080/login.
NOTE: (per default this API uses the H2-DataBase which doesn't need additional programs to be used. To change this to MySQL or similar DBMS read here).
Authentication
| HTTP | URL | Authentication | Request Body (JSON) | Response Body (JSON) |
|---|---|---|---|---|
| GET | /api/welcome | no | serialized authentication object | [empty] |
| GET | /api/token | yes (basic) | serialized authentication object | [empty] |
Welcome message:
GET /api/welcomeRequest new JWT-Token:
GET /api/token
Users
| HTTP | URL | Authentication | Request Body (JSON) | Response Body (JSON) |
|---|---|---|---|---|
| POST | /api/users | yes | serialized user object | serialized user object |
| GET | /api/users | yes | [empty] | serialized Iterable |
| GET | /api/users/basic | yes | [empty] | serialized Iterable |
| GET | /api/users/{id} | yes | [empty] | serialized user object |
| PUT | /api/users/{id} | yes | serialized user object | [empty] |
| DELETE | /api/users/{id} | yes | [empty] | [empty] |
Save a new user:
POST /api/users
Find all users:
GET /api/users/basicFind all basic users:
GET /api/users/basicFind a specific user:
GET /api/users/{id}
Update or replace a user:
PUT /api/users/{id}
Delete a specific user:
DELETE /api/users/{id}
Messages
| HTTP | URL | Authentication | Request Body (JSON) | Response Body (JSON) |
|---|---|---|---|---|
| POST | /api/messages | yes | serialized message object | serialized message object |
| GET | /api/messages | yes | [empty] | serialized Iterable |
| GET | /api/messages/by/{id} | yes | [empty] | serialized Iterable |
| GET | /api/messages/{id} | yes | [empty] | serialized message object |
| PUT | /api/messages/{id} | yes | serialized message object | [empty] |
| DELETE | /api/messages/{id} | yes | [empty] | [empty] |
| DELETE | /api/messages/{time} | yes | [empty] | [empty] |
Save a new message:
POST /api/messages
Find all messages:
GET /api/messagesFind all messages sent by a specific user:
GET /api/messages/by/{id}Find a specific message:
GET /api/messages/{id}
Update or replace a message:
PUT /api/messages/{id}
Delete a specific message:
DELETE /api/messages/{id}Delete all messages sent before a certain date:
DELETE /api/messages/{time}
Conversations
| HTTP | URL | Authentication | Request Body (JSON) | Response Body (JSON) |
|---|---|---|---|---|
| POST | /api/conversations | yes | serialized conversation object | serialized conversation object |
| GET | /api/conversations | yes | [empty] | serialized Iterable |
| GET | /api/conversations/{id} | yes | [empty] | serialized conversation object |
| GET | /api/conversations/of/{id} | yes | [empty] | serialized Iterable |
| GET | /api/conversations/of/{id}/active | yes | [empty] | serialized Iterable |
| GET | /api/conversations/of/{id}/inactive | yes | [empty] | serialized Iterable |
| PUT | /api/conversations/{id} | yes | serialized conversation object | [empty] |
| DELETE | /api/conversations/{id} | yes | [empty] | [empty] |
Save a new conversation:
POST /api/conversations
Find all conversations:
GET /api/conversationsFind all conversations of a specific user:
GET /api/conversations/of/{id}Find all active conversations of a specific user:
GET /api/conversations/of/{id}/activeFind all inactive conversations of a specific user:
GET /api/conversations/by/{id}/inactiveFind a specific conversation:
GET /api/conversations/{id}
Update or replace a conversation:
PUT /api/conversations{id}
Delete a specific conversation:
DELETE /api/conversations/{id}
Per default the standard H2-DataBase is used. To change this to a MySQL database:
- Create a new schema called "haruchat" in MySQL
- Open application.properties
-
change:
spring.datasource.url=jdbc:h2:mem:testdb
to:spring.datasource.url=jdbc:mysql://localhost:3306/haruchat -
add:
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver spring.jpa.hibernate.ddl-auto=update -
insert your MySQL credentials in
spring.datasource.username=andspring.datasource.password=
-
-
Adding method level authorization -
Adding unit tests -
Integration of this API in a mobile App, most likely written in Kotlin or creation of a React web-app using this API -
...
GNU Affero General Public License v3.0 ( AGPL-3.0 license )
Carlo Bortolan · GitHub @carlobortolan · e-mail @[email protected]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent