是否有在文档中定义 Rest API 的工具？ [关闭]答案

【问题标题】：Is there tools to define Rest API in document ? [closed]是否有在文档中定义 Rest API 的工具？ [关闭]
【发布时间】：2013-09-10 06:31:38
【问题描述】：

关于生成 Rest API 到 html 文档的许多问题。

但是鸡蛋来自鸡。

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

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

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

我们可以编辑，时间过去后更新它。网页/客户端开发者，只需要看文档，就可以开始了。

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

【问题讨论】：

标签： api rest web

【解决方案1】：

有一些文档规范允许客户端发现 RESTful API。

我使用了 swagger，效果很好。该规范处理您提到的事情：

描述请求/响应的 JSON Schema
错误代码/条件列表
codegen library 为多种语言生成客户端代码，例如 Javascript、Java、Objective-C、Scala、PHP、Python、Ruby 等。

【讨论】：

swagger 没有设计 api。它只是从现有代码生成API，但代码应该在设计API文档发布之后。
Swagger 分为几个部分。用于描述/设计 API 的文档（请参阅 here），使用该 API 文档创建人类可读 Web UI 的应用程序（请参阅演示 here 和代码 here），最后是使用的 codegen library生成代码的api文档。在我的工作中，我们在实现之前将 API 调用添加到 swagger 文档中。