Skip to content
HTTP API design guide extracted from work on the Heroku Platform API
Branch: master
Clone or download
geemus Merge pull request #96 from jessieay/master
Add guidance on providing standard response types
Latest commit e1c44aa Mar 18, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
en Add object type def Mar 15, 2019
it Revert "adding github pages" Jul 2, 2014 update contributors Apr 24, 2015 add italian to langs Apr 25, 2016

HTTP API Design Guide

This guide describes a set of HTTP+JSON API design practices, originally extracted from work on the Heroku Platform API.

This guide informs additions to that API and also guides new internal APIs at Heroku. We hope it’s also of interest to API designers outside of Heroku.

Our goals here are consistency and focusing on business logic while avoiding design bikeshedding. We’re looking for a good, consistent, well-documented way to design APIs, not necessarily the only/ideal way.

We assume you’re familiar with the basics of HTTP+JSON APIs and won’t cover all of the fundamentals of those in this guide.

Available for online reading and in multiple formats at gitbook.

We welcome contributions to this guide.

See Summary for Table of Contents.

For the best reading experience, we recommend reading via GitBook.

Gitbook Translations

Git Translations

You can’t perform that action at this time.