martinez2001 / userbasicapi Goto Github PK

Description:
API action to get a user's data

Example:

Happy path:
Request: GET /api/user/1

Response: 200 OK

{
id: '1'
email: '[email protected]'
}

User ID does not exist

Request: GET /api/user/999

Response: 400 Bad Response

{
error: 'user does not exist'
}

Description
A client can receive a list of users

Example

Happy path:
Request: GET /api/users/list

Response: 200 OK

{ id:'1' , id:'2' , id:'3' }

In case there are no users
Request: GET /api/users/list

Response: 200 OK

[]

Generic error:
Request: GET /api/users/list

Response: 400 Bad Response

{ 'error': 'An error occured while a petition was made' }