Great RESTful APIs look like they were designed by a single team. This promotes API adoption, reduces friction, and enables clients to use them properly. To build APIs that meet this standard, and to answer many common questions encountered along the way of RESTful API development, the Zalando Tech team has created this comprehensive set of guidelines. We have shared it with you to inspire additional discussion and refinement within and among your teams, and contribute our learnings and suggestions to the tech community at large.
Feel free to use these guidelines as a guidance for your own development. Note that we encourage our own teams to use them in order to challenge their APIs. As such, you should consider this to be a living, evolving document. We will revise and update based on our learnings and experiences.
You can easily generate PDF, ePub, Mobi files out of our guidelines. Please refer to this explanation - you have to install Callibre. You have to use node version 5.1.1 to build the guidelines. CAUTION: you need to add version 2.6.7 identifier to every build command:
$ npm install
# Generate a PDF file
$ ./node_modules/.bin/gitbook -v 2.6.7 pdf ./ ./api-guidelines.pdf
# Generate an ePub file
$ ./node_modules/.bin/gitbook -v 2.6.7 epub ./ ./api-guidelines.epub
# Generate a Mobi file
$ ./node_modules/.bin/gitbook -v 2.6.7 mobi ./ ./api-guidelines.mobiAfter a short Introduction, these guidelines include chapters on the following topics:
- Design Principles
- General Guidelines
- Security
- Compatibility
- JSON Guidelines
- Naming
- Resources
- HTTP
- Performance
- Pagination
- Hypermedia
- Data Formats
- Common Data Objects
- Common Headers
- Proprietary Headers
- API Operation
- Events
- Tooling
We have published these guidelines under the CC-BY (Creative commons Attribution 4.0) license. Please see LICENSE file.