在没有swagger.json的情况下使用OpenAPI / Swagger CodeGen

Question

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

是否有一条前进的道路可以让我在这个API中使用swagger-codegen工具？也就是说，我知道我通常可以为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工具是否具有允许上述内容的任何内容，或者是否在项目的范围之外？

Answer 1

如果您无法访问源代码，我担心自动生成文档会很困难。正如您在选项1中所说，您最好的选择是为此API编写自己的OpenAPI规范。

如果您最终手动创建文档，我强烈建议您使用Swagger编辑器来编写并验证doc：https://editor.swagger.io/