http-api-design 0,1,2,0,1,2,0,4

HTTP API design guide extracted from work on the Heroku Platform API

4 months after

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

Related Repositories

restful-api-design-references

restful-api-design-references

RESTful API 设计参考文献列表,可帮助你更加彻底的了解REST风格的接口设计。 ...

javascript-sdk-design

javascript-sdk-design

JavaScript SDK design guide extracted from work and personal experience ...

javascript-sdk-design

javascript-sdk-design

JavaScript SDK design guide extracted from work and personal experience ...

consumer-centric-api-design

consumer-centric-api-design

LaTeX: CC Book on HTTP API Design ...

http-api-design-zh-cn

http-api-design-zh-cn

根据 Heroku Platform API 的设计经验总结而来的 HTTP API 设计指南 ...


Top Contributors

geemus mmcgrana 0x13a brandur chentsulin hkulekci jmnavarro steookk joe-mojo Gutem neonstalwart benoittgt dpassage DyegoCosta kcyeu couchand jamesmanning triplepoint jroes karlcoelho keithamus ms-ati elmariofredo iffy OscarScholten rhoberman snkashis stevenbeeckman krallin tomchristie