api - 是否有在文档中定义 Rest API 的工具？

Question

很多关于将 Rest API 生成到 html 文档的问题都会被问到。

但鸡蛋来自鸡肉。

在很多情况下，架构需要定义 API。它是 Web 开发人员和 iOS/Android 客户端开发人员之间的连接。

那么有没有这样的工具或网络，我们可以做以下事情：

新的 API 编写 subURL 编写 POST/GET 方法 编写 post 参数 编写返回的答案 编写示例请求，任何类型的条件，错误代码。毕竟，那里有一个 doc 或 Online doc html。

我们可以编辑，在时间过去后更新它。Web/客户端开发人员，只需要观看文档，然后他们就可以开始了。

有什么工具可以存档吗？谢谢你。

Answer 1

有几个文档规范允许客户端发现 RESTful API。

• 招摇（演示）

• 蜂房

• JSON主页

• Google 使用他们自己的Discovery Service，但与其他人不同的是，不幸的是，我认为没有开源库可以帮助您使用自己的 API 公开它。

我用过招摇，效果很好。该规范处理您提到的事情：

• JSON Schema 来描述请求/响应

• 错误代码/条件列表

• 一个代码生成库，用于为 Javascript、Java、Objective-C、Scala、PHP、Python、Ruby 等多种语言生成客户端代码。