https://github.com/zalando/restful-api-guidelines

A model set of guidelines for RESTful APIs and Events, created by Zalando
https://github.com/zalando/restful-api-guidelines

api documentation guidelines rest-api restful restful-api zalando

Last synced: 25 days ago
JSON representation

A model set of guidelines for RESTful APIs and Events, created by Zalando

• Host: GitHub
• URL: https://github.com/zalando/restful-api-guidelines
• Owner: zalando
• License: cc-by-4.0
• Created: 2016-04-01T15:06:54.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-09-18T11:38:14.000Z (about 2 months ago)
• Last Synced: 2024-09-26T22:42:58.707Z (about 1 month ago)
• Topics: api, documentation, guidelines, rest-api, restful, restful-api, zalando
• Language: CSS
• Homepage: https://opensource.zalando.com/restful-api-guidelines/
• Size: 28.8 MB
• Stars: 2,618
• Watchers: 75
• Forks: 384
• Open Issues: 14
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.adoc
  • License: LICENSE

Awesome Lists containing this project

• awesome-rest - Restful API Guidelines by Zalando - Developing Restful APIs: A Comprehensive Set of Guidelines. (Design / Guidelines)
• jimsghstars - zalando/restful-api-guidelines - A model set of guidelines for RESTful APIs and Events, created by Zalando (CSS)

README

        
= Developing Restful APIs: A Comprehensive Set of Guidelines by Zalando

https://github.com/zalando/restful-api-guidelines/actions/[image:https://github.com/zalando/restful-api-guidelines/actions/workflows/build.yml/badge.svg[Build status]]

Latest published version:

http://zalando.github.io/restful-api-guidelines/[*HTML*],

== 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 link:BUILD.adoc[BUILD documentation] for technical details.

== License

We have published these guidelines under the CC-BY (Creative commons

Attribution 4.0) license. Please see link:LICENSE[LICENSE file].