Created
July 7, 2014 21:35
-
-
Save taylorrf/b2a3e5ffcd49c1cf4c29 to your computer and use it in GitHub Desktop.
GuruRS Mock API
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FORMAT: 1A | |
HOST: http://api.gururs.com | |
# GuruRS | |
It's the API to share the reference books used on GuruRS of Jully. | |
# Group Books | |
Books related resources of the **Books API** | |
## Books Collection [/books] | |
### List all Books [GET] | |
+ Response 200 (application/json) | |
[{ | |
"id": 1, "title": "Web API Design: Crafting Interfaces that Developers Love", "author": "Brian Mulloy", "url": "https://pages.apigee.com/web-api-design-ebook.html" | |
}, { | |
"id": 2, "title": "Your API is Bad", "author": "Paddy Foran", "url": "https://leanpub.com/yourapiisbad" | |
},{ | |
"id": 3, "title": "HTTP Succinctly", "author": "Scott Allen", "url": "https://www.syncfusion.com/resources/techportal/ebooks/http" | |
}] | |
### Create a Book [POST] | |
+ Request (application/json) | |
{ "title": "Web API Design: Crafting Interfaces that Developers Love", author: "Brian Mulloy", "url": "https://pages.apigee.com/web-api-design-ebook.html" } | |
+ Response 201 (application/json) | |
{ "id": 1, "title": "Web API Design: Crafting Interfaces that Developers Love", author: "Brian Mulloy", "url": "https://pages.apigee.com/web-api-design-ebook.html" } | |
## Book [/books/{id}] | |
A single Book object with all its details | |
+ Parameters | |
+ id (required, number, `1`) ... Numeric `id` of the Book to perform action with. | |
### Retrieve a Book [GET] | |
+ Response 200 (application/json) | |
+ Header | |
X-My-Header: The Value | |
+ Body | |
{ "id": 1, "title": "Web API Design: Crafting Interfaces that Developers Love", "author": "Brian Mulloy", "url": "https://pages.apigee.com/web-api-design-ebook.html" } | |
### Remove a Book [DELETE] | |
## Book Author [/books/{id}/author] | |
All details of book author | |
+ Parameters | |
+ id (required, number, `1`) ... Numeric `id` of the Book to perform action with. | |
### Retrieve a Book [GET] | |
+ Response 200 (application/json) | |
+ Header | |
X-My-Header: The Value | |
+ Body | |
{ "id": 3, "name": "Brian Mulloy", "twitter": "bmulloy" } | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment