Home

Workgroup REST Design

• Organization
• OpenAPI data types
• Meeting Reports

Reference material

This section lists sources which served as an inspiration for the REST guide.

Industry REST style guides

Some other REST style guides from the industry:

REST API Design Rulebook

Awesome REST list

Google JSON Style Guide

GitHub REST API

Zalando API Guidelines

Paypal API Standards

National Bank of Belgium REST API Design Guide

Microsoft REST API guidelines

DigiPolis Antwerpen API guidelines

Vlaamse overheid

Burgerprofiel Vlaanderen (builds upon Vlaamse Overheid's guidelines)

Other compilations

http://apistylebook.com/design/guidelines/ (or sorted by topic)

https://dret.github.io/guidelines/

Error handling

• error code lists in use by organizations

Code examples

Code examples of contract first API development with Java and Maven, provided by eHealth (note: Swagger not conform rest guide)