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

时间:2013-09-06 08:13:45

标签: api rest web

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

但鸡蛋来自鸡肉。

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

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

新API 写subURL 编写POST / GET方法 写帖子参数 写下返回的答案 写样本请求,各种条件,错误代码。 毕竟,在那里有一个doc或Online doc html。

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

有什么样的工具可以存档吗?谢谢。

1 个答案:

答案 0 :(得分:6)

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

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

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

  • 错误代码/条件列表

  • codegen library生成多种语言的客户端代码,如Javascript,Java,Objective-C,Scala,PHP,Python,Ruby等。