Jay Taylor's notes

back to listing index


[web search]
Original source (github.com)
Tags: api http github.com
Clipped on: 2015-12-09

Skip to content
HTTP API design guide extracted from work on the Heroku Platform API https://www.gitbook.com/read/book/geemus/http-api-design


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.

We welcome contributions to this guide.

See Summary for Table of Contents.