Swagger UI 可根据 OpenAPI 规范文件自动生成可交互的 API 文档。
OpenAPITools/openapi-generator
根据 OpenAPI 规范自动生成多种语言的 API 客户端 SDK、服务端桩代码和文档。
- Star
- 26,806
- Fork
- 7,720
- 未关闭 Issue
- 5,779
- 最近提交
- 7小时前
这是什么?
OpenAPI Generator 读取 OpenAPI 规范文件,自动生成对应代码。它支持大量语言和框架的 API 客户端库,覆盖常见 Web 框架的服务端桩代码,并可输出 HTML、Markdown、AsciiDoc 等格式的 API 文档。规范版本支持 OpenAPI 2.0 和 3.0,3.1 为测试版支持。
项目基于 Java 开发,可通过 JAR 包、Homebrew、Docker 镜像、npm 包装器以及 Maven、Gradle 插件使用。既可以在命令行运行,也可以集成到构建工具中,或部署为自托管的 Web 服务,通过 HTTP 提交规范并获取生成代码的压缩包。
团队常用它来替代手写和维护客户端代码,在 CI 构建中随 API 定义的变化同步更新 SDK。
核心功能
- 01为数十种编程语言和 HTTP 客户端库生成 API 客户端代码。
- 02为 Spring、FastAPI、Ktor 等多种框架生成服务端桩代码。
- 03生成 HTML、Markdown、AsciiDoc 等格式的 API 文档。
- 04支持 OpenAPI 2.0 和 3.0 规范,3.1 为测试版支持。
- 05提供命令行工具、Docker 镜像、Maven 和 Gradle 插件以及自托管 Web 服务等多种使用方式。
适用场景
- 为对外公开的 REST API 生成带类型的 SDK,分发给用户使用。
- 在实现之前,根据 API 设计生成服务端代码框架。
- 通过 CI 流水线让客户端库与 API 规范保持同步。
- 基于规范生成最新的 HTML 或 Markdown 格式 API 文档。
标签
常见问题
- openapi-generator 是什么?
- 根据 OpenAPI 规范自动生成多种语言的 API 客户端 SDK、服务端桩代码和文档。 OpenAPI Generator 读取 OpenAPI 规范文件,自动生成对应代码。它支持大量语言和框架的 API 客户端库,覆盖常见 Web 框架的服务端桩代码,并可输出 HTML、Markdown、AsciiDoc 等格式的 API 文档。规范版本支持 OpenAPI 2.0 和 3.0,3.1 为测试版支持。
- openapi-generator 可以免费使用吗?用的什么许可证?
- openapi-generator 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
- openapi-generator 还在维护吗?
- 活跃维护中。openapi-generator 最近一次提交是在 2026年10月18日。
- openapi-generator 适合用来做什么?
- 为对外公开的 REST API 生成带类型的 SDK,分发给用户使用。 在实现之前,根据 API 设计生成服务端代码框架。 通过 CI 流水线让客户端库与 API 规范保持同步。 基于规范生成最新的 HTML 或 Markdown 格式 API 文档。
- 在哪里获取 openapi-generator?
- 源代码和安装说明在 GitHub 上:https://github.com/OpenAPITools/openapi-generator
概要由 AI 根据项目 README 生成;GitHub 数据每日更新。
相关项目
2.9万9250JavaScriptApache-2.0更新于 前天
开源 API 开发工具,可在网页、桌面端和命令行中发送与测试 HTTP、GraphQL、WebSocket 等请求。
8.1万6172TypeScriptMIT更新于 7天前
开源自托管 PDF 处理平台,可在浏览器、桌面端或通过 API 编辑、签名、涂黑、转换和自动化处理 PDF。
9.4万1.2万TypeScriptOther更新于 1小时前
基于 Django 的开源自托管健身训练、营养与体重记录工具,支持 Docker 部署和 REST API。
71421041PythonAGPL-3.0更新于 3天前
为 Hack、Source Code Pro 等开发者字体打上数千个图标字形补丁,并提供现成的已修补字体。
6.5万3957CSSOther更新于 23小时前
基于 QEMU 的封装工具,无需复杂配置即可快速创建并运行 Windows、macOS 和 Linux 虚拟机。
1.7万759ShellMIT更新于 4天前