API Style Guides

Zalando RESTful API and Event Guidelines

The canonical open community style guide. Maintained by Zalando's API Guild and widely cited as the reference implementation for an API-First, OpenAPI-based REST and event-driven API program. Roughly 150+ numbered MUST/SHOULD/MAY rules covering REST basics, design, operation, and AsyncAPI-style event types.

Documentation GitHub

SDKs

📦

GitHubRepository

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

Other Resources

🔗

StyleGuide

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

🔗

SpectralRuleset

https://github.com/zalando/zally

🔗

Scope

API entry from apis.yml

aid: style-guides:zalando
name: Zalando RESTful API and Event Guidelines
description: The canonical open community style guide. Maintained by Zalando's API Guild and widely cited
  as the reference implementation for an API-First, OpenAPI-based REST and event-driven API program. Roughly
  150+ numbered MUST/SHOULD/MAY rules covering REST basics, design, operation, and AsyncAPI-style event
  types.
humanURL: https://opensource.zalando.com/restful-api-guidelines/
baseURL: https://opensource.zalando.com/restful-api-guidelines/
tags:
- REST
- Events
- API First
- OpenAPI
- Zalando
properties:
- type: StyleGuide
  url: https://opensource.zalando.com/restful-api-guidelines/
- type: GitHubRepository
  url: https://github.com/zalando/restful-api-guidelines
- type: SpectralRuleset
  url: https://github.com/zalando/zally
- type: Scope
  data:
    surfaces:
    - REST
    - Events
    publisher: Zalando SE
    license: CC BY 4.0
    status: living
    approxRules: 150+