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

Question

关闭。这个问题不满足Stack Overflow guidelines .它目前不接受答案。












想改善这个问题吗？更新问题，使其成为 on-topic对于堆栈溢出。

6年前关闭。




Improve this question




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

但是鸡蛋来自鸡肉。

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

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

新建一个 API
写子URL
编写 POST/GET 方法
写post参数
写下返回的答案
编写示例请求，任何类型的条件，错误代码。
毕竟，那里有一个文档或在线文档 html。

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

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

Answer 1

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

Swagger ( demo )

apiary

JSON Home

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

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

用于描述请求/响应的 JSON 模式

错误代码/条件列表

codegen library为多种语言生成客户端代码，例如 Javascript、Java、Objective-C、Scala、PHP、Python、Ruby 等。