Swagger-Codegen 是一个代码生成器,基于Swagger定义的RESTful API生成服务端和客户端代码。使用该工具,可以快速生成类型安全的API请求代码,减少手动编写的工作量。本文介绍如何快速了解其使用步骤,包括通过命令行工具安装与运行。
01
如何安装
仅针对 MacOS,其它系统可以通过下载代码使用
代码下载地址:github.com/swagger-api…
通过 HomeBrew 安装 brew install swagger-codegen
-
打开终端
-
输入指令:brew install swagger-codegen
如果 Homebrew 已经很长时间没使用了,会自动更新 Homebrew 中已安装的依赖包
- 检测Swagger Codegen 安装是否成功,输入指令:Swagger-Codegen help
- 查找安装成功后的Swagger Codegen 文件
指令下载的文件会被隐藏,电脑重启后就没有了,可以复制到别的路径
command+shift+G,输入: /tmp/SwaggerDemo/
02
如何使用
确保你有一个 OpenAPI 规范文件(通常是 YAML 或 JSON 格式)
[专注] 在线JSON 文件:petstore.swagger.io/v2/swagger.…
- 使用命令:
Swagger-Codegen generate -i http://petstore.swagger.io/v2/swagger.json -l typescript-axios -o /tmp/SwaggerDemo/
这里的`-i`参数是输入的OpenAPI文档路径,`-g`参数指定生成TypeScript axios客户端,
`-o`参数是输出目录
[专注] 本地JSON 文件:
- 新建一个json文件
swagger.json
/Users/work/SwaggerDemo/swagger.jsonswagger.json 文件地址
/Users/work/SwaggerDemo/ SwaggerDemo 文件夹地址
- 使用命令:
Swagger-Codegen generate -i /Users/work/SwaggerDemo/swagger.json -l typescript-axios -o /Users/work/SwaggerDemo/
03
如何修改数据,看生成新的 ts 代码
介绍如何修改json 文件,生成新的ts
- 修改json
- 输入指令:
Swagger-Codegen generate -i /Users/work/SwaggerDemo/swagger.json -l typescript-axios -o /Users/work/SwaggerDemo/
- 查看新的ts 代码
04
其它命令
介绍其它几种常用命令
-
列出所有支持的语言:
openapi-generator-cli list -
显示特定生成器的帮助:
openapi-generator-cli config-help -g {语言} -
升级 OpenAPI Generator 到最新版本:
openapi-generator-cli version-manager upgrade