0

我有一个没有考虑Swagger构建的 REST API 。它没有 swagger.json 文件。我不控制这个 API。API 基于 URL,响应 GET、POST 和 PUT 请求,并返回 JSON 或 XML。

是否有前进的道路可以让我swagger-codegen通过这个 API 使用该工具?也就是说,我知道我通常可以为 API 生成客户端代码

$ swagger-codegen generate -i http://petstore.swagger.io/v2/swagger.json -l ruby -o /tmp/test/

我想知道是否有办法

  1. 为 API 编写我自己的 swagger.json 文件
  2. 做——什么?-- 将请求和响应转换为这个遗留 REST API 所期望的格式

swagger/OpenAPI 工具是否有任何允许上述内容的功能,或者是否超出了项目的范围?

4

1 回答 1

0

如果您无权访问源代码,恐怕很难自动生成文档。正如您在选项 1 中所说,您最好的选择可能是为此 API 编写您自己的 OpenAPI 规范。

如果您最终手动创建文档,我强烈建议您使用 Swagger Editor 来编写和验证文档:https ://editor.swagger.io/

于 2019-02-27T18:35:02.473 回答