{"id":13395321,"url":"https://github.com/interagent/http-api-design","last_synced_at":"2025-05-14T00:10:57.180Z","repository":{"id":16784438,"uuid":"19542809","full_name":"interagent/http-api-design","owner":"interagent","description":"HTTP API design guide extracted from work on the Heroku Platform API","archived":false,"fork":false,"pushed_at":"2024-01-16T20:27:54.000Z","size":154,"stargazers_count":13698,"open_issues_count":31,"forks_count":1060,"subscribers_count":509,"default_branch":"master","last_synced_at":"2025-04-13T13:12:03.785Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://geemus.gitbooks.io/http-api-design/content/en/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/interagent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-05-07T17:00:37.000Z","updated_at":"2025-04-10T09:58:29.000Z","dependencies_parsed_at":"2024-11-30T03:10:04.305Z","dependency_job_id":null,"html_url":"https://github.com/interagent/http-api-design","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interagent%2Fhttp-api-design","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interagent%2Fhttp-api-design/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interagent%2Fhttp-api-design/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interagent%2Fhttp-api-design/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/interagent","download_url":"https://codeload.github.com/interagent/http-api-design/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254044376,"owners_count":22005148,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T17:01:52.386Z","updated_at":"2025-05-14T00:10:52.172Z","avatar_url":"https://github.com/interagent.png","language":null,"readme":"# HTTP API Design Guide\n\nThis guide describes a set of HTTP+JSON API design practices, originally\nextracted from work on the [Heroku Platform API](https://devcenter.heroku.com/articles/platform-api-reference).\n\nThis guide informs additions to that API and also guides new internal\nAPIs at Heroku. We hope it’s also of interest to API designers\noutside of Heroku.\n\nOur goals here are consistency and focusing on business logic while\navoiding design bikeshedding. We’re looking for _a good, consistent,\nwell-documented way_ to design APIs, not necessarily _the only/ideal\nway_.\n\nWe assume you’re familiar with the basics of HTTP+JSON APIs and won’t\ncover all of the fundamentals of those in this guide.\n\nAvailable for online reading and in multiple formats at [gitbook](https://geemus.gitbooks.io/http-api-design).\n\nWe welcome [contributions](https://github.com/interagent/http-api-design/blob/master/CONTRIBUTING.md) to this guide.\n\nSee [Summary](en/SUMMARY.md) for Table of Contents.\n\nFor the best reading experience, we recommend reading via [GitBook](https://geemus.gitbooks.io/http-api-design).\n\n### Gitbook Translations\n * [English](https://geemus.gitbooks.io/http-api-design/content/en/index.html)\n * [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/)\n * [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/)\n\n### Git Translations\n * [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/)\n * [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/)\n * [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/)\n * [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/)\n * [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/)\n * [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/)\n","funding_links":[],"categories":["Others","API Design Guides","miscellaneous","书籍 / 阅读","Other","Design","Getting started","Restful API Guidelines","JavaScript","others","HTTP API Design","best practises from industry","Design Guides","Categories","书籍 / 阅读 / 学习"],"sub_categories":["Desktop","API","HTTP Design","Overview","API-Blueprint","API design"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finteragent%2Fhttp-api-design","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finteragent%2Fhttp-api-design","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finteragent%2Fhttp-api-design/lists"}