Update README.md

This commit is contained in:
Tokishu
2025-05-30 17:19:15 -07:00
committed by GitHub
parent e86b8bf08e
commit 75d37a160a
+31 -3
View File
@@ -2,13 +2,40 @@
I'm testing spring boot, and it might become my main framework for building APIs I'm testing spring boot, and it might become my main framework for building APIs
## Endpoits ## Authentication Endpoints
Handle user registration and login. All return JWT tokens on success.
### `POST /api/auth/register` - Register a new user
Request body:
```json
{
"username":"Tokishu",
"password":"SuperSecretPassword"
}
```
### `POST /api/auth/login` - Authorize
Request body:
```json
{
"username":"Tokishu",
"password":"SuperSecretPassword"
}
```
### `/api/auth/new-root` - Initial setup endpoint to create a root user (e.g. admin), can only be used once.
## Note Endpoints
All endpoints below require a valid Bearer token in the `Authorization` header.
`Authorization: Bearer <your_token>`
### `GET /api/notes` - Get all notes ### `GET /api/notes` - Get all notes
### `GET /api/note/{id}` - Find note by id ### `GET /api/note/{id}` - Find note by id
### `POST /api/note` - Add a new note ### `POST /api/note` - Add a new note
``` Request body:
```json
{ {
"name":"What should I buy?", "name":"What should I buy?",
"text":"Tanya's note" "text":"Tanya's note"
@@ -16,7 +43,8 @@ I'm testing spring boot, and it might become my main framework for building APIs
``` ```
### `PUT /api/note/{id}` - Update note ### `PUT /api/note/{id}` - Update note
``` Request body:
```json
{ {
"name":"What should I buy?", "name":"What should I buy?",
"text":"I bought the apple!" "text":"I bought the apple!"