【问题标题】:Using OpenAPI/Swagger CodeGen without a swagger.json在没有 swagger.json 的情况下使用 OpenAPI/Swagger CodeGen
【发布时间】:2019-07-08 13:27:45
【问题描述】:

我有一个 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 工具是否有任何允许上述内容的功能,或者是否超出了项目的范围?

【问题讨论】:

  • 第 2 步的原因是什么?如果你有一个开放 API 定义,你会为代码生成做好准备,不是吗?是否需要转型?

标签: swagger openapi swagger-codegen openapi-generator


【解决方案1】:

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

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

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2020-05-09
    • 2015-08-01
    • 2022-01-04
    • 2018-09-11
    • 2019-02-09
    • 2020-10-18
    • 1970-01-01
    • 2020-02-28
    相关资源
    最近更新 更多