同步操作将从 暮光:城中城/swagger-mg-ui 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
swagger-mg-ui是swagger的一个前端实现,使用简单、解析速度快、走心的设计,支持多项目同时展示,多种文档目录的展示方案,多种自定义配置,满足各种使用习惯,使用中您有任何的意见和建议都可到源码地址处反馈哦!
1、每个项目都要集成swagger-mg-ui包,可不可以 文档和项目分开 ?
2、document.html是个静态页面,怎么能做一些 权限控制 呢?登录后才能查看
3、 其他编程语言 产生的swagger文档怎么可以使用这个文档工具查看呢?
4、可不可以关闭线上的文档,用 本地的文档页面调试线上的接口 呢?
5、项目非常的多,需要记许多的文档地址,能不能 统一管理 呢?
现在,新的项目:zyplayer-doc-swagger解决你的一切烦恼!已集成本文档,欢迎查看
每一行代码都是从头开始写的,所以每一个问题都能及时得到解决
欢迎多多Star!右上角↗
demo代码地址: swagger-mg-ui-demo
已上传至中央仓库,使用方法:
1、添加依赖
<!-- https://mvnrepository.com/artifact/com.zyplayer/swagger-mg-ui -->
<dependency>
<groupId>com.zyplayer</groupId>
<artifactId>swagger-mg-ui</artifactId>
<version>1.0.6</version>
</dependency>
2、启动后访问:http://localhost:8080/document.html
实现MgStorageService并申明为@Service之后网页上才能使用服务器端的存储能力,同时需要在@EnableSwagger2的地方添加@EnableSwaggerMgUi注解,才能开启存储的接口
开放存储能力的好处: 所有网页的配置、调试值都可以存储到服务器的数据库中,便于团队所有人的调试,一人配置,所有人受益 如果不开启的话,数据是存放在浏览器的localStorage中,每个人、每个浏览器都得配置一次才能使用
开启@EnableSwaggerMgUi注解坏处: 暴露了一个请求任意地址的接口,比如任意内部接口,所以不建议在线上项目开启此注解,单独的本地的文档管理项目才开启,不会对外暴露此接口,切记!!!!
还有线上项目切记关闭swagger的接口扫描,不然别人就能拿到服务器的所有接口了,专门的对外文档还是可以,但还是尽量关闭,使用本项目的文档导出功能给第三方!
判断是否是模拟请求,功能需求: 很多时候后端定义好了接口,但还未实现,这时前端已经需要数据调试了,这时就需要用到这个过滤器了! 在页面上先配置好模拟返回的数据,然后在url上加入参数:mgUiTestFlag=1 例:http://192.168.0.249:8082/openApi/case/info?mgUiTestFlag=1 本过滤器就直接返回了之前配置的模拟数据,而不用等到后端必须把接口实现之后才能调试,或者在前端写一大段测试数据。也可以只复制本项目里的MgUiTestFilter.java代码到被访问的项目里
例:笔者的公司后端人较少,一个需求需要10个接口,需求分析完后首先就把接口、参数、返回值定义好,然后一个个的去实现。 也许需要10天才能写完,但前端两天就写好了,急需数据看效果,这时就让他们自己去设置模拟值,加上参数自己测试好。 而不是一味的催后台,把各种锅丢给后端,然后玩自己的去了,浪费各环节等待时间。
如果需要看多个项目的文档,不再需要对让被访问的项目支持跨域访问!因为已集成服务器端代理请求,想请求什么都行!把在线调试当postman来用都行!(虽然功能差得远,但基础的用是没问题的,够用就行,不断完善中)
maven项目,前端由html、js、css组成的,后端使用java,前端框架使用的zui
欢迎加入群聊讨论:
支持添加和管理任意swagger文档地址:
多分文档时可选择只展示某一个文档:
多种展示方式:
在线调试支持单行和多行编辑模式:
文档展示页面:
在线调试页面:
模拟返回页面:
导出文档:
复制文档内容:
独立文档查看:
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。