前言
这篇指南介绍描述了 HTTP+JSON API 的一种设计模式，最初摘录整理自 Heroku 平台的 API 设计指引 Heroku 平台 API 指引。
这篇指南除了详细介绍现有的 API 外，Heroku 将来新加入的内部 API 也会符合这种设计模式，我们希望非 Heroku 员工的API设计者也能感兴趣。
我们的目标是保持一致性，专注业务逻辑同时避免过度设计。我们一直试图找出一种良好的、一致的、显而易见的 API 设计方法，而并不是所谓的"最终/理想模式"。
我们假设你熟悉基本的 HTTP+JSON API 设计方法，所以本篇指南并不包含所有的 API 设计基础。
我们欢迎你为这篇指南做贡献。
提供机器可读的JSON模式
提供一个机器可读的模式来恰当的表现你的API。使用
prmd管理你的模式，并且确保用prmd verify验证是有效的。
提供人类可读的文档
提供人类可读的文档让客户端开发人员可以理解你的API。
如果你用prmd创建了一个概要并且按上述要求描述，你可以为所有节点很容易的使用prmd doc生成Markdown文档。
除了节点信息，提供一个API概述信息:
-
验证授权，包含如何取得和如何使用token。
-
API稳定及版本管理，包含如何选择所需要的版本。
-
一般情况下的请求和响应的头信息。
-
错误的序列化格式。
-
不同编程语言客户端使用API的例子。
提供可执行的例子
提供可执行的示例让用户可以直接在终端里面看到API的调用情况，最大程度的让这些示例可以简单的使用，以减少用户尝试使用API的工作量。例如:
$ export TOKEN=... # acquire from dashboard
$ curl -is https://$TOKEN@service.com/users如果你使用prmd生成Markdown文档，每个节点都会自动获取一些示例。
描述稳定性
描述您的API的稳定性或是它在各种各样节点环境中的完备性和稳定性，例如：加上 原型版（prototype）/开发版（development）/产品版（production）等标记。
更多关于可能的稳定性和改变管理的方式，查看 Heroku API compatibility policy
一旦你的API宣布产品正式版本及稳定版本时，不要在当前API版本中做一些不兼容的改变。如果你需要，请创建一个新的版本的API。
原文:
https://segmentfault.com/a/1190000002518410