1. 安装Swagger Codegen工具
在Ubuntu上,Swagger Codegen的安装方式主要有两种:
sudo apt-get update更新软件包索引,再运行sudo apt-get install swagger-codegen安装最新稳定版。安装完成后,可通过swagger-codegen version验证是否成功。pip3 install swagger-codegen。这种方式适合需要灵活管理工具版本的用户。2. 准备OpenAPI规范文件
Swagger Codegen依赖OpenAPI规范文件(.yaml或.json格式)生成客户端代码,该文件需描述API的接口路径、请求方法、参数、响应模型等信息。获取途径有两种:
snap install swagger-editor --classic安装)在线设计API,保存后导出为.yaml或.json文件。3. 生成客户端代码
打开终端,导航至OpenAPI规范文件所在目录,执行以下命令:
swagger-codegen generate -i /path/to/your-api-spec.yaml -l <目标语言> -o /path/to/output/directory
-i:指定规范文件的路径(如~/api-spec.yaml);-l:指定生成的目标语言(支持java、python、javascript、csharp、go等,具体可通过swagger-codegen langs查看);-o:指定输出目录(如~/client-code)。~/java-client目录的命令为:swagger-codegen generate -i ~/api-spec.yaml -l java -o ~/java-client
若需自定义生成选项(如指定包名、输出格式),可添加额外参数(如--package-name com.example.client),具体参数可通过swagger-codegen generate -h查看。
4. 集成与使用生成的代码
mvn clean install),生成可执行的JAR文件;pom.xml添加生成的模块依赖,或直接复制源代码到项目目录);ApiClient、UserService)发起API请求,例如:ApiClient client = new ApiClient();
client.setBasePath("https://api.example.com");
UserService userService = new UserService(client);
User user = userService.getUserById(123); // 调用生成的接口方法
```。
注意事项
-t参数指定自定义模板目录(模板文件可从Swagger Codegen GitHub仓库下载);