Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/interagent/http-api-design

HTTP API design guide extracted from work on the Heroku Platform API
https://github.com/interagent/http-api-design

Last synced: 12 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/interagent/http-api-design
Owner: interagent
License: other
Created: 2014-05-07T17:00:37.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-01-16T20:27:54.000Z (11 months ago)
Last Synced: 2024-10-15T10:22:27.768Z (about 2 months ago)
Homepage: https://geemus.gitbooks.io/http-api-design/content/en/
Size: 150 KB
Stars: 13,685
Watchers: 512
Forks: 1,064
Open Issues: 31
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

awesome - interagent/http-api-design - HTTP API design guide extracted from work on the Heroku Platform API (miscellaneous)
awesome-rest - HTTP API design guide extracted from work on the Heroku Platform API
awesome-github-repos - interagent/http-api-design - HTTP API design guide extracted from work on the Heroku Platform API (Others)
guides - HTTP API Design Guide
awesome-rest - HTTP API design guide extracted from work on the Heroku Platform API
awesome-ruby-api - http-api-design - HTTP API design guide extracted from work on the Heroku Platform API. (Design Guides)
awesome-styleguides - http-api-design
starred-awesome - http-api-design - HTTP API design guide extracted from work on the Heroku Platform API (Others)
awesome-starred - interagent/http-api-design - HTTP API design guide extracted from work on the Heroku Platform API (others)

README

        # HTTP API Design Guide

This guide describes a set of HTTP+JSON API design practices, originally

extracted from work on the [Heroku Platform API](https://devcenter.heroku.com/articles/platform-api-reference).

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](https://geemus.gitbooks.io/http-api-design).

We welcome [contributions](https://github.com/interagent/http-api-design/blob/master/CONTRIBUTING.md) to this guide.

See [Summary](en/SUMMARY.md) for Table of Contents.

For the best reading experience, we recommend reading via [GitBook](https://geemus.gitbooks.io/http-api-design).

### Gitbook Translations

 * [English](https://geemus.gitbooks.io/http-api-design/content/en/index.html)

 * [Italian](https://geemus.gitbooks.io/http-api-design/content/it/index.html) (based on [f12db3e](https://github.com/interagent/http-api-design/commit/f12db3e)), by [@diegomariani](https://github.com/diegomariani/)

 * [Simplified Chinese](https://one-programmer.github.io/docs/http-api-design/) (based on [40d114b](https://github.com/interagent/http-api-design/commit/40d114b6efbc60b84c804dbe7ad34b0d5e155a49)), by [@ZhangBohan](https://github.com/ZhangBohan/)

### Git Translations

 * [Korean](https://github.com/yoondo/http-api-design) (based on [f38dba6](https://github.com/interagent/http-api-design/commit/f38dba6fd8e2b229ab3f09cd84a8828987188863)), by [@yoondo](https://github.com/yoondo/)

 * [Portuguese](https://github.com/Gutem/http-api-design/) (based on [fba98f08b5](https://github.com/interagent/http-api-design/commit/fba98f08b50acbb08b7b30c012a6d0ca795e29ee)), by [@Gutem](https://github.com/Gutem/)

 * [Simplified Chinese](https://github.com/ZhangBohan/http-api-design-ZH_CN) (based on [337c4a0](https://github.com/interagent/http-api-design/commit/337c4a05ad08f25c5e232a72638f063925f3228a)), by [@ZhangBohan](https://github.com/ZhangBohan/)

 * [Spanish](https://github.com/jmnavarro/http-api-design) (based on [2a74f45](https://github.com/interagent/http-api-design/commit/2a74f45b9afaf6c951352f36c3a4e1b0418ed10b)), by [@jmnavarro](https://github.com/jmnavarro/)

 * [Traditional Chinese](https://github.com/kcyeu/http-api-design) (based on [232f8dc](https://github.com/interagent/http-api-design/commit/232f8dc6a941d0b25136bf64998242dae5575f66)), by [@kcyeu](https://github.com/kcyeu/)

 * [Turkish](https://github.com/hkulekci/http-api-design/tree/master/tr) (based on [c03842f](https://github.com/interagent/http-api-design/commit/c03842fda80261e82860f6dc7e5ccb2b5d394d51)), by [@hkulekci](https://github.com/hkulekci/)