swaggest/swac

swaggest/swac Docker镜像文档

镜像概述

swaggest/swac Docker镜像是基于https://github.com/swaggest/swac%E9%A1%B9%E7%9B%AE%E6%9E%84%E5%BB%BA%E7%9A%84Swagger/OpenAPI%E4%BB%A3%E7%A0%81%E7%94%9F%E6%88%90%E5%B7%A5%E5%85%B7%E9%95%9C%E5%83%8F%EF%BC%8C%E7%94%A8%E4%BA%8E%E5%B0%86Swagger%E6%88%96OpenAPI%E6%A0%BC%E5%BC%8F%E7%9A%84API%E8%A7%84%E8%8C%83%E6%96%87%E4%BB%B6%E6%B8%B2%E6%9F%93%E4%B8%BA%E5%A4%9A%E7%A7%8D%E7%BC%96%E7%A8%8B%E8%AF%AD%E8%A8%80%E7%9A%84%E4%BB%A3%E7%A0%81%EF%BC%8C%E7%AE%80%E5%8C%96API%E5%BC%80%E5%8F%91%E6%B5%81%E7%A8%8B%E3%80%82

核心功能与特性

• 支持Swagger和OpenAPI规范文件的解析与代码生成
• 可生成多种编程语言的API客户端、服务端代码或数据模型
• 自动化代码生成，减少手动编码工作量，提高开发效率
• 保持API规范与代码的一致性，降低维护成本

使用场景

• API开发团队根据OpenAPI规范自动生成客户端SDK
• 服务端开发中基于API规范生成接口框架代码
• 多语言项目中统一API规范并自动生成对应语言代码
• CI/CD流程中集成，实现API规范变更后的自动代码更新

使用方法

基本使用（docker run）

bash
docker run --rm -v $(pwd):/work swaggest/swac generate -i /work/openapi.yaml -o /work/generated -l go

参数说明：

• -v $(pwd):/work：将当前目录挂载到容器内的/work目录，用于输入API规范文件和输出生成的代码
• generate：swac的核心命令，用于生成代码
• -i /work/openapi.yaml：指定输入的API规范文件路径（容器内路径）
• -o /work/generated：指定代码输出目录（容器内路径，对应宿主机当前目录下的generated文件夹）
• -l go：指定生成代码的目标语言（支持go、java、python等，具体可参考https://github.com/swaggest/swac%EF%BC%89

查看帮助

如需查看更多命令和参数，可运行：

bash
docker run --rm swaggest/swac --help