Last active
June 17, 2016 20:27
-
-
Save d-smith/42f439a386a163fab247 to your computer and use it in GitHub Desktop.
API design guidelines
This file contains hidden or 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
| Principles: | |
| The API's job is to make the developer as successful as possible [1] | |
| Making an easy to consume API is more important that adhering to REST, might want to call it | |
| a Web API or an HTTP API instead of a REST API. | |
| Fundamental Decision: | |
| Are we building a hypermedia API? I think not... are we all on board with that? | |
| Refs: | |
| [1] Web API Design - Crafting Interfaces that Developers Love | |
| Some links: | |
| http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api | |
| http://ws-rest.org/2012/proc/a8-1-amundsen.pdf | |
| http://www.toptal.com/api-developers/5-golden-rules-for-designing-a-great-web-api | |
| http://lcsd05.cs.tamu.edu/slides/keynote.pdf | |
| http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api | |
| https://mathieu.fenniak.net/the-api-checklist/ | |
| https://www.phase2technology.com/blog/your-comprehensive-web-api-design-checklist/ | |
| https://google.github.io/styleguide/jsoncstyleguide.xml | |
| https://github.com/WhiteHouse/api-standards | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment