-
Notifications
You must be signed in to change notification settings - Fork 152
Home
Welcome!
As explained in the readme, this is the REST API Design Guide of the National Bank of Belgium.
Rules and guidelines in this design guide have different levels. Some are optional while some others are mandatory. Also, there are recommendations against some approaches, as well as things that are simply forbidden.
Here's how each term should be understood: MUST: it's mandatory (i.e., hard rule) MUST NOT: it's forbidden (i.e., hard rule) SHOULD: it's heavily recommended (i.e., soft rule) SHOULD NOT: there may exist valid reasons not to respect this but the implications should be well understood MAY/OPTIONAL: it's optional (i.e., advice)
Take a look at RFC 2119 for more details.
This project is distributed under the terms of the EUPL FOSS license
REST Resources Design Workflow
REST Resources Single items and collections
REST Resources Many to many Relations
REST Resources Relations expansion
HTTP Status Codes Success (2xx)
HTTP Status Codes Redirection (3xx)
HTTP Status Codes Client Error (4xx)
HTTP Status Codes Server Error (5xx)
Pagination Out of range/bounds
Long-running Operations Example
Concurrency vs Delete operation
Caching and conditional requests About
Caching and conditional requests Rules
Caching and conditional requests HTTP headers
Error handling Example with a single error
Error handling Example with multiple errors
Error handling Example with parameters
Error handling Example with additional metadata
Bulk operations HTTP status codes
Bulk operations Resources naming convention
Bulk operations Creation example
Bulk operations Update example
Bulk operations Create and update example
File upload Simple file upload
File upload Simple file upload example
File upload Complex file upload
File upload Complex file upload example
REST Security General recommendations
REST Security Insecure direct object references