Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cn-src/swagger-document-ui
Swagger 文档型 UI
https://github.com/cn-src/swagger-document-ui
springfox springfox-swagger-ui swagger swagger-ui
Last synced: 2 days ago
JSON representation
Swagger 文档型 UI
- Host: GitHub
- URL: https://github.com/cn-src/swagger-document-ui
- Owner: cn-src
- License: apache-2.0
- Created: 2018-08-24T02:30:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-16T07:07:27.000Z (about 3 years ago)
- Last Synced: 2023-07-28T00:18:26.785Z (over 1 year ago)
- Topics: springfox, springfox-swagger-ui, swagger, swagger-ui
- Language: JavaScript
- Size: 8.74 MB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/Apache-2.0)
[](https://travis-ci.org/cn-src/swagger-document-ui)
[](https://search.maven.org/search?q=g:cn.javaer.springfox%20AND%20a:swagger-document-ui&core=gav)
[](https://gitee.com/cn-src/swagger-document-ui/stargazers)
# Swagger 规范接口的 UI
---
- 主要体现文档的可读性功能，给接口调用者提供接口文档，省去文档编写。
- 此项目没有类似官方的在线测试/调试功能，建议使用 Postman，Postman 默认支持 swagger 规范的接口导入，但文件夹结构不与文档一致，所以定制了 Postman 导出功能。
- [在线样例](http://cn-src.gitee.io/swagger-document-ui/swagger-ui.html)
- [更新日志](https://github.com/cn-src/swagger-document-ui/releases)
# 使用方式
## springfox 框架集成
- [springfox 官方文档](http://springfox.github.io/springfox/docs/current/)
1. 移除官方 UI 依赖
```xml
io.springfox
springfox-swagger-ui
${springfox.version}
```
2. 添加 swagger-document-ui 依赖
```xml
cn.javaer.springfox
swagger-document-ui
1.0.2
```
## Spring Boot 集成
与 Spring Boot 集成使用是最简单的方式，推荐使用 [程序猿 DD/spring-boot-starter-swagger](https://gitee.com/didispace/spring-boot-starter-swagger)
提供的集成方式，然后你需要：
1. 排除自带 UI 依赖
```xml
com.spring4all
swagger-spring-boot-starter
${swagger-spring-boot-starter.version}
springfox-swagger-ui
io.springfox
```
2. 添加 swagger-document-ui 依赖
```xml
cn.javaer.springfox
swagger-document-ui
1.0.2
```
## 静态资源部署
> 此项目最终是生成纯静态资源，只要将 dist 目录里的静态文件部署到 web 服务器下即可使用，但前提是：你的项目中使用了 swagger 规范的 API 信息接口。
1. 其会请求 `/swagger-resources` （springfox 框架默认地址） 和 `/swagger-resources.json` （本项目新增地址） 拿到 API 信息接口地址。
2. 请求 `swagger-resources` 中配置的 `url`（优先） 或者 `location`（兼容旧版不提供 url 字段） 其应当返回 swagger 规范的 API 信息即可使用。
3. 可参考在线样例的部署方式，分支：[online-demo](https://gitee.com/cn-src/swagger-document-ui/tree/online-demo/)
# 效果预览
## 右侧文档锚点导航
## 分组选择 API
## 模糊搜索
- 支持中文，拼音，英文
- 可搜索 API 名称，分类名称，url 路径
## 导出 Postman
