/api-guidelines

RESTful HTTP API guidelines and best practices.

REST API Guidelines

These REST API Guidelines, as a design principle, encourage application developers to make resources accessible to via one or more RESTful HTTP interfaces. To provide the smoothest possible experience for developers on platforms following these REST API Guidelines, REST APIs SHOULD follow consistent design guidelines to make using them easy and intuitive.

Guidelines

See Guidelines.md.

Acknowledgements

These guidelines borrow heavily from the JSON API 1.0 Specification and Microsoft REST API Guidelines.

A big thank you to Dana Franklin for his invaluable advice and extensive contributions to these guidelines.