http-api-design

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

  • Owner: interagent/http-api-design
  • Platform:
  • License:: Other
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

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

Main metrics

Overview
Name With Ownerinteragent/http-api-design
Primary Language
Program language (Language Count: 0)
Platform
License:Other
所有者活动
Created At2014-05-07 17:00:37
Pushed At2024-01-16 20:27:54
Last Commit At2024-01-16 14:27:52
Release Count0
用户参与
Stargazers Count13.7k
Watchers Count509
Fork Count1.1k
Commits Count132
Has Issues Enabled
Issues Count48
Issue Open Count29
Pull Requests Count39
Pull Requests Open Count2
Pull Requests Close Count14
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private