OpenAPI生成器能否同步生成TypeScript-Axios单元测试与客户端SDK？

1. 准备规范文件 #

确保你有符合OpenAPI 3.x/2.0标准的YAML或JSON格式规范文件，比如openapi.yaml，文件需包含完整的接口路径、请求参数、响应结构等定义。

2. 安装OpenAPI生成器 #

两种常用安装方式：

• npm全局安装：npm install @openapitools/openapi-generator-cli -g
• Docker镜像：确保本地已部署Docker环境，后续直接用镜像执行命令

3. 执行生成命令 #

通过指定参数开启测试生成功能，直接生成客户端SDK和对应的单元测试：

npm全局安装场景 #

openapi-generator-cli generate \
  -i ./openapi.yaml \
  -g typescript-axios \
  -o ./generated-client \
  --additional-properties=generateTests=true,testFolder=__tests__

Docker场景 #

docker run --rm \
  -v "$(pwd):/local" openapitools/openapi-generator-cli generate \
  -i /local/openapi.yaml \
  -g typescript-axios \
  -o /local/generated-client \
  --additional-properties=generateTests=true,testFolder=__tests__

参数说明：

• -i：指定OpenAPI规范文件路径
• -g：指定生成器类型（固定为typescript-axios）
• -o：生成文件的输出目录
• --additional-properties：额外配置项，generateTests=true开启测试生成，testFolder指定测试文件存放目录

4. 生成结果说明 #

生成的目录结构中：

• src文件夹：包含完整的TypeScript-Axios客户端代码，包括API调用类、请求/响应类型定义、拦截器配置等
• __tests__文件夹：对应每个API的单元测试文件，基于Jest框架编写，会模拟Axios请求，验证接口调用逻辑、参数处理和响应解析逻辑

5. 测试环境配置（可选） #

如果需要运行生成的测试，需在生成目录下安装依赖并配置测试脚本：

cd ./generated-client
npm install jest @types/jest ts-jest -D

然后在package.json中添加测试命令：

"scripts": {
  "test": "jest"
}

内容的提问来源于stack exchange，提问作者user