This is a simple pet store REST API that simplifies interaction between pet owners and customers.
Register as a new user
POST https://localhost:3000/sign_up?as=:role
| Parameter | Type | Description |
|---|---|---|
| role | String | User role. pet_owner, manager, customer |
{
"email": "[email protected]",
"role": "customer",
"created_at": "2018-06-20T20:30:15.425Z",
"updated_at": "2018-06-20T20:30:15.425Z"
}
View the details of multiple pets
GET https://localhost:3000/pets?limit=:limit&offset=:offset
| Parameter | Type | Description |
|---|---|---|
| limit | String | How many pets to return. Default is 10 |
| offset | String | Result offset. Default is 0. |
[
{
"id": "6YEfR6",
"name": "foo",
"pet_type": "cat",
"created_at": "2018-06-20T20:28:52.561Z",
"updated_at": "2018-06-20T20:29:54.801Z",
"owner": {
"email": "[email protected]",
"role": "pet_owner",
"created_at": "2018-06-20T20:27:23.013Z",
"updated_at": "2018-06-20T20:27:23.013Z"
}
},
{
"id": "6YFfR6",
"name": "bar",
"pet_type": "cat",
"created_at": "2018-06-20T20:28:53.561Z",
"updated_at": "2018-06-20T20:29:56.801Z",
"owner": {
"email": "[email protected]",
"role": "manager",
"created_at": "2018-06-20T20:27:23.013Z",
"updated_at": "2018-06-20T20:27:23.013Z"
}
}
]
View the details of a single pet
GET https://localhost:3000/pets/:id
| Parameter | Type | Description |
|---|---|---|
| id | String | REQUIRED Pet ID |
| name | type | description |
|---|---|---|
| String | REQUIRED Email address | |
| password | String | REQUIRED Password |
| password | String | REQUIRED Password confirmation |
{
"id": "673fL6",
"name": "foo",
"pet_type": "cat",
"created_at": "2018-06-19T20:37:38.442Z",
"updated_at": "2018-06-19T21:03:01.976Z",
"owner": {
"email": "[email protected]",
"created_at": "2018-06-19T20:36:16.703Z",
"updated_at": "2018-06-19T20:36:16.703Z"
}
}
Add a new pet to your collection
POST https://localhost:3000/pets
| Parameter | Type | Description |
|---|---|---|
| name | String | REQUIRED Pet name |
| pet_type | String | REQUIRED Pet type. dog, cat |
{
"id": "673fL6",
"name": "foo",
"pet_type": "cat",
"created_at": "2018-06-19T20:37:38.442Z",
"updated_at": "2018-06-19T21:03:01.976Z",
"owner": {
"email": "[email protected]",
"created_at": "2018-06-19T20:36:16.703Z",
"updated_at": "2018-06-19T20:36:16.703Z"
}
}
Update an existing pet
PUT https://localhost:3000/pets/:id
| Parameter | Type | Description |
|---|---|---|
| id | String | REQUIRED Pet ID |
| Parameter | Type | Description |
|---|---|---|
| name | String | REQUIRED Pet name |
| pet_type | String | REQUIRED Pet type. dog, cat |
{}
Delete an existing pet
DELETE https://localhost:3000/pets/:id
| Parameter | Type | Description |
|---|---|---|
| id | String | REQUIRED Pet ID |
{}
View the details of multiple categories
GET https://localhost:3000/categories?limit=:limit&offset=:offset
| Parameter | Type | Description |
|---|---|---|
| limit | String | How many categories to return. Default is 10 |
| offset | String | Result offset. Default is 0. |
[
{
"id": 1,
"name": "foo",
"created_at": "2018-06-20T23:15:33.008Z",
"updated_at": "2018-06-20T23:15:33.008Z",
"user": {
"email": "[email protected]",
"role": "manager",
"created_at": "2018-06-20T20:27:23.013Z",
"updated_at": "2018-06-20T20:27:23.013Z"
},
"pets": []
},
{
"id": 2,
"name": "bar",
"created_at": "2018-06-20T23:15:33.008Z",
"updated_at": "2018-06-20T23:15:33.008Z",
"user": {
"email": "[email protected]",
"role": "manager",
"created_at": "2018-06-20T20:27:23.013Z",
"updated_at": "2018-06-20T20:27:23.013Z"
},
"pets": []
}
]
View the details of a single category
GET https://localhost:3000/categories/:id
| Parameter | Type | Description |
|---|---|---|
| id | String | REQUIRED Category ID |
{
"id": 1,
"name": "foo",
"created_at": "2018-06-20T23:15:33.008Z",
"updated_at": "2018-06-20T23:15:33.008Z",
"user": {
"email": "[email protected]",
"role": "manager",
"created_at": "2018-06-20T20:27:23.013Z",
"updated_at": "2018-06-20T20:27:23.013Z"
},
"pets": []
}
Add a new category to your collection
POST https://localhost:3000/categories
| Parameter | Type | Description |
|---|---|---|
| name | String | REQUIRED Category name |
{
"id": 1,
"name": "foo",
"created_at": "2018-06-20T23:15:33.008Z",
"updated_at": "2018-06-20T23:15:33.008Z",
"user": {
"email": "[email protected]",
"role": "manager",
"created_at": "2018-06-20T20:27:23.013Z",
"updated_at": "2018-06-20T20:27:23.013Z"
},
"pets": []
}
Update an existing category
PUT https://localhost:3000/categories/:id
| Parameter | Type | Description |
|---|---|---|
| id | String | REQUIRED Category ID |
| Parameter | Type | Description |
|---|---|---|
| name | String | REQUIRED Category name |
| pet_ids | Array | REQUIRED IDs of pets that belongs to the category. |
{}
Delete an existing category
DELETE https://localhost:3000/categories/:id
| Parameter | Type | Description |
|---|---|---|
| id | String | REQUIRED Category ID |
{}