parsertongue/swagger-codegen-cli

swagger-codegen-cli Docker镜像

镜像概述

这是一个用于https://github.com/swagger-api/swagger-codegen%E7%9A%84%E5%A4%9A%E5%B9%B3%E5%8F%B0Docker%E9%95%9C%E5%83%8F%EF%BC%88https://github.com/clu-ling/docker-swagger-codegen-cli%EF%BC%89%E3%80%82swagger-codegen-cli%E6%98%AF%E4%B8%80%E6%AC%BE%E5%9F%BA%E4%BA%8EOpenAPI%E8%A7%84%E8%8C%83%E7%94%9F%E6%88%90API%E5%AE%A2%E6%88%B7%E7%AB%AF%E3%80%81%E6%9C%8D%E5%8A%A1%E5%99%A8%E5%AD%98%E6%A0%B9%E5%92%8C%E6%96%87%E6%A1%A3%E7%9A%84%E5%B7%A5%E5%85%B7%EF%BC%8C%E6%9C%AC%E9%95%9C%E5%83%8F%E6%8F%90%E4%BE%9B%E5%AE%B9%E5%99%A8%E5%8C%96%E9%83%A8%E7%BD%B2%E6%96%B9%E5%BC%8F%EF%BC%8C%E6%97%A0%E9%9C%80%E6%9C%AC%E5%9C%B0%E5%AE%89%E8%A3%85%E5%8D%B3%E5%8F%AF%E4%BD%BF%E7%94%A8%E5%85%B6%E5%8A%9F%E8%83%BD%E3%80%82

核心功能与特性

• 多平台支持：适配多种架构，满足不同环境部署需求
• 工具集成：完整集成swagger-codegen-cli功能，包含所有官方生成器
• 即开即用：无需复杂配置，通过Docker命令直接执行代码生成任务
• 文件挂载：支持本地目录挂载，方便处理本地OpenAPI规范文件

使用场景

适用于需要基于OpenAPI规范（原Swagger规范）进行API开发的场景，包括：

• 生成多种编程语言（如Java、Python、JavaScript等）的API客户端
• 创建服务器端框架（如Spring、Node.js等）的存根代码
• 转换OpenAPI规范格式（如YAML与JSON互转）
• 生成API文档

使用方法

基本说明

详细生成器使用说明请参见https://github.com/swagger-api/swagger-codegen#generators%E3%80%82

将OpenAPI YAML转换为OpenAPI JSON

假设OpenAPI规范文件myschema.yml位于本地/path/to/schema目录，执行以下命令进行格式转换：

bash
docker run -it -v /path/to/schema:/app "parsertongue/swagger-codegen-cli:latest" generate -i /app/myschema.yml -l openapi

参数说明：

• -it：以交互模式运行容器
• -v /path/to/schema:/app：将本地/path/to/schema目录挂载到容器内/app目录，实现文件共享
• generate：swagger-codegen-cli的核心生成命令
• -i /app/myschema.yml：指定输入的OpenAPI规范文件路径（容器内路径，对应本地挂载目录中的文件）
• -l openapi：指定生成器类型为openapi，用于OpenAPI规范格式转换

转换后的JSON文件将生成在容器内的当前工作目录，可通过挂载目录获取到本地。