Repolode
提交项目
swagger-api

swagger-api/swagger-ui

Swagger UI 可根据 OpenAPI 规范文件自动生成可交互的 API 文档。

可替代:PostmanReadMe

在 GitHub 查看官网
Star
29,040
Fork
9,250
未关闭 Issue
1,144
最近提交
3天前

这是什么？

Swagger UI 是一组 HTML、JavaScript 和 CSS 静态资源，可将 OpenAPI（原 Swagger）规范渲染为可浏览的文档页面。开发者和 API 使用方无需先编写调用代码，就能在页面上查看每个接口、参数和响应结构，并直接发送测试请求。

项目提供三种发布形式：适用于带打包工具单页应用的 swagger-ui npm 模块；不依赖其他包、可部署在服务端或无法解析 npm 依赖的应用中的 swagger-ui-dist；以及封装为 React 组件的 swagger-ui-react。也可以直接把 dist 目录中的 HTML、JS、CSS 文件复制到任意 Web 服务器上使用。

当前版本支持 OpenAPI 2.0 至 3.2.0 的多个规范版本，可在最新版 Chrome、Safari、Firefox 和 Edge 中运行。

核心功能

  • 01将 OpenAPI 和 Swagger 规范渲染为可交互的文档页面。
  • 02支持在浏览器中直接向接口发送测试请求。
  • 03提供 npm 模块、无依赖的 dist 静态包和 React 组件三种形式。
  • 04支持 OAuth2 授权以及指向具体操作的深度链接。
  • 05可通过配置项、插件 API 和自定义布局进行定制。

适用场景

  • 为后端服务发布面向内部或外部使用者的 API 参考文档。
  • 让前端和移动端团队在编写客户端代码前先试用接口。
  • 在 React 应用中嵌入可交互的 API 文档。
  • 在无法安装 npm 依赖的服务器上提供静态 API 文档。

标签

#openapi#swagger#api-documentation#rest-api#javascript#api-testing#hacktoberfest#oas#open-source#openapi-specification

常见问题

swagger-ui 是什么？
Swagger UI 可根据 OpenAPI 规范文件自动生成可交互的 API 文档。 Swagger UI 是一组 HTML、JavaScript 和 CSS 静态资源，可将 OpenAPI（原 Swagger）规范渲染为可浏览的文档页面。开发者和 API 使用方无需先编写调用代码，就能在页面上查看每个接口、参数和响应结构，并直接发送测试请求。
swagger-ui 可以免费使用吗？用的什么许可证？
swagger-ui 以 Apache-2.0 许可证开源。用于商业产品前，请先确认许可证条款。
swagger-ui 还在维护吗？
活跃维护中。swagger-ui 最近一次提交是在 2026年10月16日。
swagger-ui 适合用来做什么？
为后端服务发布面向内部或外部使用者的 API 参考文档。 让前端和移动端团队在编写客户端代码前先试用接口。 在 React 应用中嵌入可交互的 API 文档。 在无法安装 npm 依赖的服务器上提供静态 API 文档。
在哪里获取 swagger-ui？
源代码和安装说明在 GitHub 上：https://github.com/swagger-api/swagger-ui

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

相关项目