• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

swagger-document-ui: Springfox & Swagger 文档型 UI

原作者: [db:作者] 来自: 网络 收藏 邀请

LicenseBuild StatusMaven Centralstar

Swagger 规范接口的 UI


  • 主要体现文档的可读性功能,给接口调用者提供接口文档,省去文档编写。
  • 此项目没有类似官方的在线测试/调试功能,建议使用 Postman,Postman 默认支持 swagger 规范的接口导入,但文件夹结构不与文档一致,所以定制了 Postman 导出功能。
  • 在线样例
  • 更新日志

使用方式

springfox 框架集成

  1. 移除官方 UI 依赖
<dependency>    <groupId>io.springfox</groupId>    <artifactId>springfox-swagger-ui</artifactId>    <version>${springfox.version}</version></dependency>
  1. 添加 swagger-document-ui 依赖
<dependency>    <groupId>cn.javaer.springfox</groupId>    <artifactId>swagger-document-ui</artifactId>    <version>1.0.2</version></dependency>

Spring Boot 集成

与 Spring Boot 集成使用是最简单的方式,推荐使用 程序猿 DD/spring-boot-starter-swagger提供的集成方式,然后你需要:

  1. 排除自带 UI 依赖
<dependency>    <groupId>com.spring4all</groupId>    <artifactId>swagger-spring-boot-starter</artifactId>    <version>${swagger-spring-boot-starter.version}</version>    <!--排除自带 UI 依赖-->    <exclusions>        <exclusion>            <artifactId>springfox-swagger-ui</artifactId>            <groupId>io.springfox</groupId>        </exclusion>    </exclusions></dependency>
  1. 添加 swagger-document-ui 依赖
<dependency>    <groupId>cn.javaer.springfox</groupId>    <artifactId>swagger-document-ui</artifactId>    <version>1.0.2</version></dependency>

静态资源部署

此项目最终是生成纯静态资源,只要将 dist 目录里的静态文件部署到 web 服务器下即可使用,但前提是:你的项目中使用了 swagger 规范的 API 信息接口。

  1. 其会请求 /swagger-resources (springfox 框架默认地址) 和 /swagger-resources.json (本项目新增地址) 拿到 API 信息接口地址。
  2. 请求 swagger-resources 中配置的 url(优先) 或者 location(兼容旧版不提供 url 字段) 其应当返回 swagger 规范的 API 信息即可使用。
  3. 可参考在线样例的部署方式,分支:online-demo

效果预览

右侧文档锚点导航

分组选择 API

模糊搜索

  • 支持中文,拼音,英文
  • 可搜索 API 名称,分类名称,url 路径

导出 Postman


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap