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

Question

有关生成Rest API到html文档的许多问题.

但鸡蛋来自鸡肉.

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

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

新建一个API写入subURL写入POST/GET方法写入post参数写入返回的答案写入样本请求,任何种类的条件,错误代码.毕竟,有一个doc或Online doc html.

我们可以编辑,经过一段时间后更新它.网络/客户端开发人员,只需要观看文档,然后他们就可以开始了.

有什么样的工具可以存档吗？谢谢.

Answer 1

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

我使用了招摇,效果很好.规范处理你提到的事情:

昂首阔步分为几个部分。您用来描述/设计API的文档（请参阅[here]（https://github.com/wordnik/swagger-core/wiki/API-Declaration）），该应用程序使用该api文档创建人类可读的网络用户界面（请参见演示[此处]（http://petstore.swagger.wordnik.com/#!/user）和代码[此处]（https://github.com/wordnik/swagger-ui）），最后是[ codegen库]（https://github.com/wordnik/swagger-codegen），该库使用api文档生成代码。在我的工作中，我们在实施前将API调用添加到swagger文档。 (2认同)