API TITLE HERE
API ¶
Resource ¶
GET/v1/users/{id}
description
Fetch the user
Note
Example URI
GET https://api.example.com/v1/users/1
URI Parameters
- id
number
(required) Example: 1user id
Response
200
Headers
Content-Type: application/json
Body
{
"id": 1,
"name": "name",
"email": "example@example.com",
"created_at": "2017-08-23 00:43:21",
"updated_at": "2017-08-23 00:43:21"
}
Resource ¶
GET/v1/users?{&name,email,limit,offset,order_by,direction}
description
Search users
Note
Example URI
GET https://api.example.com/v1/users?&name=name&email=example&limit=10&offset=10&order_by=created_at&direction=desc
URI Parameters
- name
string
(optional) Example: nameName
string
(optional) Example: exampleEmail
- limit
number
(required) Example: 10Limit for the pagination
- offset
number
(required) Example: 10Offset for the pagination
- order_by
string
(optional) Example: created_atOrder key for the order
- direction
string
(optional) Example: descDirection for the order
Response
200
Headers
Content-Type: application/json
Body
{
"total_count": "2",
"users": [
{
"id": 1,
"name": "name",
"email": "example@example.com",
"created_at": "2017-08-23 00:43:21",
"updated_at": "2017-08-23 00:43:21"
},
{
"id": 2,
"name": "name",
"email": "example2@example.com",
"created_at": "2017-08-23 00:43:21",
"updated_at": "2017-08-23 00:43:21"
}
],
}
Resource ¶
POST/v1/users
description
Create an user
body params
Name | Type | Required | Description | Example |
---|---|---|---|---|
name | string | required | Name | name |
string | required | example@example.com | ||
password | string | required | Password | password |
Note
Example URI
POST https://api.example.com/v1/users
Response
201
Headers
Content-Type: application/json
Resource ¶
PUT/v1/users/{id}
description
Update the users
body params
Name | Type | Required | Description | Example |
---|---|---|---|---|
name | string | optional | Name | name |
string | optional | example@example.com |
Note
Example URI
PUT https://api.example.com/v1/users/1
URI Parameters
- id
number
(required) Example: 1user id.
Response
204
Headers
Content-Type: application/json