RESTful API Design Guidelines

The purpose of this document is to provide direction for keeping REST API implementations as consistent as possible. The document is addressed to developers who:

• design RESTful APIs for micro-services
• create applications that consume RESTful APIs

Contents

• TL;DR Best Practices
• Resource
• Representation
• Errors
• HTTP Status Codes
• Health Check

TODO

• Caching
• Concurrency
• Contraints
• HTTP Methods
• Localization
• Documentation
• Glossary
• HATEOAS
• Date handling
• Logging
• OpenAPI
• Http Status Codes
• Query-by-POST
• Search
• Serialization
• Versioning
• Validation
• Granularity
• References