EmilShakirov/cetragram_api

View on GitHub
doc/api/v1/images/list_images.json

Summary

Maintainability
Test Coverage
{
"resource": "Images",
"http_method": "GET",
"route": "/v1/images",
"description": "List images",
"explanation": null,
"parameters": [
{
"name": "page",
"description": {
"required": false
}
},
{
"name": "per_page",
"description": {
"required": false
}
}
],
"response_fields": [
 
],
"requests": [
{
"request_method": "GET",
"request_path": "/v1/images?page=1&per_page=24",
"request_body": null,
"request_headers": {
"Accept": "application/json"
},
"request_query_parameters": {
"page": "1",
"per_page": "24"
},
"request_content_type": null,
"response_status": 200,
"response_status_text": "OK",
"response_body": "{\"images\":[{\"id\":2,\"caption\":\"Dolorum velit reiciendis aut.\",\"link\":\"/uploads/cache/532d3118565e90e15c9c5e59ca9276bf.jpg\",\"likes\":[]}],\"meta\":{\"pagination\":{\"total\":1,\"per_page\":24,\"page\":1}}}",
"response_headers": {
"Content-Type": "application/json; charset=utf-8"
},
"response_content_type": "application/json; charset=utf-8",
"curl": "curl \"http://localhost:5000/v1/images?page=1&per_page=24\" -X GET \\\n\t-H \"Accept: application/json\" \\\n\t-H \"X-User-Email: user3@example.com\" \\\n\t-H \"X-User-Token: z8RjCcJX889PbJupMakC\""
}
]
}