Download OpenAPI specification:
Register a user
the user credentials
| name required | string[A-Za-z0-9]+ |
| password required | string <password> >= 5 characters |
{- "name": "alice",
- "password": "12345"
}{- "name": "string",
- "details": "string"
}Get the todos
| category | string Enum: "WORK" "HOME" "PERSONAL" "HEALTH" "FINANCE" Example: category=HOME the category of the todos |
[- {
- "title": "Buy milk",
- "category": "HOME",
- "dueDate": "2025-01-01",
- "completed": false
}, - {
- "title": "Book course",
- "category": "WORK",
- "completed": true
}
]Add a todo
the data of the todo
| title required | string[\p{L}\p{N} ]+ |
| category | string Enum: "WORK" "HOME" "PERSONAL" "HEALTH" "FINANCE" |
| dueDate | string <date> |
{- "title": "Buy milk",
- "category": "HOME",
- "dueDate": "2025-01-01"
}{- "id": 1,
- "title": "Buy milk",
- "category": "HOME",
- "dueDate": "2025-01-01",
- "completed": false
}Update a todo
| id required | integer Example: 1 the identifier of the todo |
the new data of the todo
| id | integer |
| title required | string[\p{L}\p{N} ]+ |
| category | string Enum: "WORK" "HOME" "PERSONAL" "HEALTH" "FINANCE" |
| dueDate | string <date> |
| completed | boolean |
{- "id": 1,
- "title": "Buy milk",
- "category": "HOME",
- "dueDate": "2025-01-01",
- "completed": true
}{- "id": 1,
- "title": "Buy milk",
- "category": "HOME",
- "dueDate": "2025-01-01",
- "completed": true
}Update the status of a todo
| id required | integer Example: 1 the identifier of the todo |
the status of the todo
| completed required | boolean |
{- "completed": true
}{- "id": 1,
- "title": "Buy milk",
- "category": "HOME",
- "dueDate": "2025-01-01",
- "completed": true
}