Repolode
提交项目
swagger-api

swagger-api/swagger-core

Java 库，通过注解和 JAX-RS 接口自动生成 OpenAPI 规范文档，支持 OpenAPI 3.x。

在 GitHub 查看官网
Star
7,535
Fork
2,255
未关闭 Issue
219
最近提交
前天

这是什么？

Swagger Core 是 OpenAPI 规范的 Java 实现。它读取 Java 应用中的注解和 REST 资源类，生成描述接口、参数、请求体和响应模型的 OpenAPI 文档，Swagger UI 等工具可据此渲染交互式 API 文档。

项目面向 JAX-RS 2 应用，同时提供 javax 和 Jakarta 两套命名空间的并行构件。2.2.0 版本起支持 OpenAPI 3.1，1.x 分支则对应 OpenAPI 2.0。项目提供 BOM 构件，便于在 Maven 和 Gradle 中统一管理各模块版本。

仓库为 Maven 多模块项目，需要 Java 11 及以上版本。示例集成项目已迁移到独立的 swagger-samples 仓库。

核心功能

  • 01根据 Java 注解和 JAX-RS 资源生成 OpenAPI 3.x 文档。
  • 02同时提供 javax 和 Jakarta 命名空间的构件。
  • 032.2.0 版本起支持 OpenAPI 3.1。
  • 04提供 BOM 构件，统一 Maven 和 Gradle 中的依赖版本。

适用场景

  • 从代码自动生成 Java REST API 的 OpenAPI 规范文档。
  • 为 JAX-RS 服务添加交互式 API 文档。
  • 在 javax 迁移到 Jakarta 命名空间的同时保留 API 文档。

使用前须知

  • 仅面向 Java 和 JAX-RS2 API，不适用于其他技术栈。

标签

#openapi#swagger#rest-api#java#api-documentation#jax-rs#hacktoberfest#open-source#openapi-specification#openapi3

常见问题

swagger-core 是什么？
Java 库，通过注解和 JAX-RS 接口自动生成 OpenAPI 规范文档，支持 OpenAPI 3.x。 Swagger Core 是 OpenAPI 规范的 Java 实现。它读取 Java 应用中的注解和 REST 资源类，生成描述接口、参数、请求体和响应模型的 OpenAPI 文档，Swagger UI 等工具可据此渲染交互式 API 文档。
swagger-core 可以免费使用吗？用的什么许可证？
swagger-core 以 Apache-2.0 许可证开源。用于商业产品前，请先确认许可证条款。
swagger-core 还在维护吗？
活跃维护中。swagger-core 最近一次提交是在 2026年11月5日。
swagger-core 适合用来做什么？
从代码自动生成 Java REST API 的 OpenAPI 规范文档。 为 JAX-RS 服务添加交互式 API 文档。 在 javax 迁移到 Jakarta 命名空间的同时保留 API 文档。
在哪里获取 swagger-core？
源代码和安装说明在 GitHub 上：https://github.com/swagger-api/swagger-core

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目