有没有工具可以在文档中定义Rest API?

8

关于生成 Rest API 到 HTML 文档的问题,有很多人在提问。

但是鸡蛋来自鸡。

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

那么,是否有这样一种工具或网站,我们可以执行以下操作:

新建一个 API 编写子 URL 编写 POST/GET 方法 编写 POST 参数 编写返回答案 编写样本请求、任何类型的条件、错误代码。 完成上述所有内容后,就会有一个文档或在线文档 HTML。

我们可以在时间流逝后编辑、更新它。Web/客户端开发人员只需查看文档,然后就可以开始开发了。

是否有任何工具可以实现这个目标?谢谢。

1个回答

6

有一些文档规范可以帮助客户发现RESTful API。

我已经使用过Swagger,并且效果很好。该规范处理了您提到的问题:

  • 使用JSON Schema描述请求/响应

  • 错误代码/条件列表

  • 代码生成库,可为多种语言(如Javascript、Java、Objective-C、Scala、PHP、Python、Ruby等)生成客户端代码。


Swagger并非API设计工具,它仅能从现有代码中生成API。因此,在发布API设计文档后再编写代码是更为合适的做法。 - Jacob
2
Swagger 由几个部分组成。一个文档用于描述/设计您的 API(请参见此处),一个应用程序使用该 API 文档创建可读的 Web UI(请参见演示此处和代码此处),最后是 codegen 库,它使用 API 文档生成代码。在我的工作中,我们会在实现之前将 API 调用添加到 Swagger 文档中。 - theon

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接