Muthu Kumar
5 years ago
2 changed files with 85 additions and 2 deletions
@ -0,0 +1,83 @@ |
|||
# Routes |
|||
|
|||
## POST `/register` |
|||
|
|||
### Request type: `application/json` |
|||
|
|||
### Request: |
|||
- username: `string` |
|||
- email: `string` |
|||
- password: `string` |
|||
|
|||
### Response: |
|||
- success: `boolean` |
|||
- msg: `string` (if success false) |
|||
|
|||
## POST `/user` |
|||
|
|||
### Request type: ``application/json`` |
|||
|
|||
### Request: |
|||
- username: `string` |
|||
- password: `string` |
|||
|
|||
### Response: |
|||
- success: `boolean` |
|||
- msg: `string` (if success false) |
|||
- token: `string` |
|||
|
|||
## GET `/search/:query` |
|||
|
|||
### Headers: |
|||
- Authentication: `token` |
|||
|
|||
### Response: |
|||
- success: `boolean` |
|||
- msg: `string` (if success false) |
|||
- results: `object array` |
|||
- movieId: `string` |
|||
- title: `string` |
|||
- overview: `string` |
|||
- poster: `string` |
|||
- release: `string` |
|||
|
|||
## GET `/movie/:movieId` |
|||
|
|||
### Headers: |
|||
- Authentication: `token` |
|||
|
|||
### Response: |
|||
- success: `boolean` |
|||
- msg: `string` (if success false) |
|||
- data: |
|||
- movieId: `string` |
|||
- title: `string` |
|||
- overview: `string` |
|||
- poster: `string` |
|||
- release: `string` |
|||
- watchStatus: `undefined|string` |
|||
- rating: `undefined|string` |
|||
|
|||
|
|||
## POST `/movie/:movieId` |
|||
|
|||
### Headers: |
|||
- Authentication: `token` |
|||
|
|||
### Request type: ``application/json`` |
|||
|
|||
### Request: |
|||
- watchStatus: `string ∈ ["PLANNED", "IN_PROGRESS", "COMPLETED"]` |
|||
- rating: `string ∈ ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10"]` |
|||
|
|||
### Response: |
|||
- success: `boolean` |
|||
- msg: `string` (if success false) |
|||
- data: |
|||
- movieId: `string` |
|||
- title: `string` |
|||
- overview: `string` |
|||
- poster: `string` |
|||
- release: `string` |
|||
- watchStatus: `undefined|string` |
|||
- rating: `undefined|string` |
Loading…
Reference in new issue