使用不带swagger.json的OpenAPI / Swagger CodeGen

Question

我有一个REST API，该API并非以Swagger为基础构建的。它没有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工具是否具有上述所有功能，或者是否超出了项目范围？

Answer 1

如果您无法访问源代码，恐怕很难自动生成文档。如您在选项1中所述，最好的选择是为该API编写自己的OpenAPI规范。

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