A model set of guidelines for RESTful APIs and Events, created by Zalando
Clone or download
Latest commit 38665bd Sep 19, 2018
Permalink
Failed to load latest commit information.
assets minor buil imporevements (#260) Aug 17, 2017
chapters Merge pull request #442 from zalando/441-replace-swagger-examples-wit… Sep 13, 2018
legacy #260 fixed rule numbers. Aug 22, 2017
sass fixing the color of inlined code within a tag (#260) Aug 24, 2017
.catwatch.yaml Added catwatch yaml Apr 8, 2016
.gitignore Merge branch 'master' into functional-naming Jun 5, 2018
.travis.yml feat: generate rules information json in travis build (#446) Sep 19, 2018
.zappr.yaml fix: compliant zappr configuration (#375) Apr 11, 2018
BUILD.adoc using asciidoctor docker image in the build process (locally and on t… Aug 22, 2017
CONTRIBUTING.adoc fix: updating information about the tooling around the rule id (#312) Nov 8, 2017
LICENSE Replace “” quotation by "". Jun 25, 2018
MAINTAINERS updateing maintainers list (#260) Aug 21, 2017
README.adoc fix links to PDF + EPUB in README.adoc Aug 30, 2017
build.sh feat: generate rules information json in travis build (#446) Sep 19, 2018
build_css.sh creating a script to generate CSS (#260) Aug 21, 2017
check_rule_ids.sh improve scripts to prevent some incorrect rule ID anchors. Aug 10, 2018
generate_rules_json.sh fix: rules json generation script (#446) Sep 19, 2018
index.adoc Merge branch 'master' into functional-naming Jun 5, 2018
new_rule_id.sh adding a script to generate a new (unused) rule id (#260) Aug 21, 2017
travis_deploy.sh fix: replace quotes in the pr/issue title (#418) Jul 4, 2018
zalando.css fixing the color of inlined code within a tag (#260) Aug 24, 2017

README.adoc

Developing Restful APIs: A Comprehensive Set of Guidelines by Zalando

Build Status Latest published version: HTML, PDF, EPUB3

Purpose

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.

Usage

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.

See BUILD documentation for technical details.

License

We have published these guidelines under the CC-BY (Creative commons Attribution 4.0) license. Please see LICENSE file.