OpenAPI Generator：API开发的瑞士军刀

ops/2025/2/27 14:30:56/

一、工具介绍

OpenAPI Generator是基于OpenAPI规范(Swagger)的代码生成工具，支持50+种编程语言的客户端/服务端代码生成。其核心价值在于：
自动化生成⇒减少重复劳动+规范API开发流程

核心能力矩阵：

功能	支持示例
客户端SDK生成	Java/Python/TypeScript等
服务端Stub生成	Spring/Node.js/Go等
文档生成	HTML/PDF/Markdown
测试代码生成	JMeter测试脚本/Postman集合/JUnit测试用例

二、典型应用场景

场景1：前后端协同开发

场景2：多语言支持项目

# 同一份API描述生成不同语言SDK
openapi-generator generate -i api.yaml -g java -o java-client/
openapi-generator generate -i api.yaml -g python -o python-client/

场景3：CI/CD集成

# GitLab CI示例
generate-sdk:image: openapitools/openapi-generator-cliscript:- openapi-generator-cli generate -i $API_SPEC_URL -g kotlin -o sdk/

三、快速上手指南

步骤1：安装工具

# 通过npm安装
npm install @openapitools/openapi-generator-cli -g# 验证安装
openapi-generator-cli version
# 输出示例：6.6.0

步骤2：准备API描述文件

# api.yaml示例
openapi: 3.0.0
info:title: User APIversion: 1.0.0
paths:/users:get:summary: 获取用户列表responses:'200':description: 成功获取用户列表

步骤3：生成客户端代码

# 生成TypeScript Axios客户端
openapi-generator-cli generate \-i api.yaml \-g typescript-axios \-o src/client/# 生成结果目录结构
src/client/
├── api.ts        # 封装好的API方法
├── configuration.ts
└── models/       # 数据模型定义

步骤4：使用生成的SDK

// 前端调用示例
import { UsersApi } from './client/api';const api = new UsersApi();
const response = await api.usersGet(); // 自动生成的API方法

四、实战应用

根据SpringBoot项目Swagger文档生成JMeter测试脚本并执行接口性能测试

openapigeneratorcli_92">1、安装openapi-generator-cli工具

这里我用的是python客户端

pip install openapi-generator-cli

这样安装是需要jdk11环境的，我本地java环境是jdk1.8

pip install openapi-generator-cli[jdk4py]

使用jdk4py代替java环境，前提是python >= 3.10

2、确认SpringBoot项目已集成Swagger

// 检查是否包含依赖（pom.xml）
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>3.0.0</version>
</dependency>

3、导出Swagger文档

访问 http://localhost:8080/v2/api-docs 保存为 swagger.json

4、生成JMeter脚本

openapi-generator-cli generate \
-i swagger.json \
-g jmeter \
-o ./jmeter-scripts \

swagger.json也可以直接替换为http://localhost:8080/v2/api-docs

5、文件结构

jmeter-scripts/
├── DefaultApi.jmx      # JMeter主脚本
├── DefaultApi.csv      # 全局配置参数

6、修改并测试

将jmx脚本文件拖入JMeter
在这里插入图片描述
之后再根据测试需求修改配置就可以啦

五、总结与建议

优势总结：
✅ 开发效率提升：减少手写API代码时间约70%
✅ 规范强制执行：确保接口文档与实现始终同步
✅ 多语言一致性：统一不同语言的API调用方式
适用场景评估：

推荐使用	不推荐使用
中大型项目需要维护多语言客户端	简单的一次性接口
需要严格接口规范的团队协作项目	高度定制化的特殊协议接口

通过OpenAPI Generator，开发者可以将更多精力集中在业务逻辑实现而非接口样板代码上。工具最新版本已支持OpenAPI 3.1规范，建议搭配Swagger Editor进行API设计验证。