大摇大摆的客户端生成
Swagger client generation
我有一个基于 npm
的项目,我想将基于 swagger
的 REST API 客户端引入其中。我的想法是拥有 API 描述 yaml
文件并在构建步骤中生成客户端。
有什么众所周知的方法吗?我只找到了 swagger-js-codegen
但我不清楚如何将其集成到构建过程中。
鉴于您的 REST API 已记录在 Swagger/OpenAPI 规范中,您可以简单地使用 curl
(或其他 http 工具)发送 HTTP 请求以生成 API 客户端作为构建过程的一部分。为http://petstore.swagger.io/v2/swagger.json
生成ruby客户端的curl请求示例如下:
curl -X POST -H "content-type:application/json" -d '{"swaggerUrl":"http://petstore.swagger.io/v2/swagger.json"}' https://generator.swagger.io/api/gen/clients/ruby
更多信息请参考https://github.com/swagger-api/swagger-codegen#online-generators。
更新:2018 年 5 月,大约 50 名 Swagger Codegen 的顶级贡献者和模板创建者决定分叉 Swagger Codegen 以维护名为 OpenAPI Generator. Please refer to the Q&A 的社区驱动版本以获取更多信息。
我有一个基于 npm
的项目,我想将基于 swagger
的 REST API 客户端引入其中。我的想法是拥有 API 描述 yaml
文件并在构建步骤中生成客户端。
有什么众所周知的方法吗?我只找到了 swagger-js-codegen
但我不清楚如何将其集成到构建过程中。
鉴于您的 REST API 已记录在 Swagger/OpenAPI 规范中,您可以简单地使用 curl
(或其他 http 工具)发送 HTTP 请求以生成 API 客户端作为构建过程的一部分。为http://petstore.swagger.io/v2/swagger.json
生成ruby客户端的curl请求示例如下:
curl -X POST -H "content-type:application/json" -d '{"swaggerUrl":"http://petstore.swagger.io/v2/swagger.json"}' https://generator.swagger.io/api/gen/clients/ruby
更多信息请参考https://github.com/swagger-api/swagger-codegen#online-generators。
更新:2018 年 5 月,大约 50 名 Swagger Codegen 的顶级贡献者和模板创建者决定分叉 Swagger Codegen 以维护名为 OpenAPI Generator. Please refer to the Q&A 的社区驱动版本以获取更多信息。