HTTP API Design Guide
A comprehensive design guide for building consistent, business-logic-focused HTTP+JSON APIs, extracted from Heroku's Platform API.
What is HTTP API Design Guide?
HTTP API Design Guide is a set of best practices and conventions for building HTTP+JSON APIs, originally extracted from the development of Heroku's Platform API. It provides a structured approach to designing consistent, maintainable, and developer-friendly APIs, helping teams avoid common pitfalls and focus on delivering business value.
API designers, backend developers, and engineering teams building or maintaining HTTP+JSON APIs who seek a standardized, battle-tested approach to API design.
Developers choose this guide because it offers practical, real-world-tested conventions from Heroku's extensive API experience, promoting consistency, reducing design debates, and improving the overall quality and usability of APIs.
Overview
HTTP API design guide extracted from work on the Heroku Platform API
Use Cases
Best For
- Establishing internal API design standards for development teams
- Designing new HTTP+JSON APIs from scratch with best practices
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
