http-api-design README

The project's README from github.com/interagent/http-api-design. As one markdown file: README.md.

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

http-api-design (interagent/http-api-design)

Searching Database…

这是什么?这是一份 HTTP+JSON API 设计实践指南,提炼自 Heroku Platform API 的工作经验,涵盖资源命名、版本控制、错误处理和分页等内容。
这是一个库,还是只是文档?这是一份文字指南(一本书或一份文档),不是需要安装或运行的代码。
我该怎么阅读?想获得最佳阅读体验,可以通过 GitBook 在线阅读;也可以从仓库中的 Summary 目录开始,浏览 Markdown 源文件。
这是设计 API 的“唯一正确方式”吗?不是。作者明确表示,这只是一种统一且文档完善的方法,不一定是唯一的或最理想的方法。
这份指南适合谁看?API 设计人员。这份指南最初为 Heroku 的内部及平台 API 编写,但也希望对任何 HTTP+JSON API 的设计人员有所帮助。
学习本指南前,我需要先了解 HTTP/JSON 吗?需要。本指南假定读者已熟悉 HTTP+JSON API 的基础知识,不会讲解这些基础内容。
这份指南有英文以外的语言版本吗?有。社区提供了多种译本,包括意大利语、简体中文、繁体中文、韩语、葡萄牙语、西班牙语和土耳其语。
当初为什么要创建这份指南?它提炼自 Heroku Platform API 的实际设计决策,旨在让各个 API 保持一致,同时避免没完没了地纠结设计细节。
Creator
interagent
Size
0.2 MB
Stars
13.7K
Updated
CommitJan 16
Age
12y
Commits · 90 Days