1 Star 1 Fork 58

dingding / swagger-mg-ui

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

swagger-mg-ui

项目介绍

swagger-mg-ui是swagger的一个前端实现,使用简单、解析速度快、走心的设计,支持多项目同时展示,多种文档目录的展示方案,多种自定义配置,满足各种使用习惯,使用中您有任何的意见和建议都可到源码地址处反馈哦!

遇到一些问题:

1、每个项目都要集成swagger-mg-ui包,可不可以 文档和项目分开

2、document.html是个静态页面,怎么能做一些 权限控制 呢?登录后才能查看

3、 其他编程语言 产生的swagger文档怎么可以使用这个文档工具查看呢?

4、可不可以关闭线上的文档,用 本地的文档页面调试线上的接口 呢?

5、项目非常的多,需要记许多的文档地址,能不能 统一管理 呢?

现在,新的项目:zyplayer-doc-swagger解决你的一切烦恼!已集成本文档,欢迎查看

重要:

  • 1.x分支为可以只导入为ui包使用的分支,无需后端支持,已进入维护阶段
  • 2.x还是为主干,必须开启后端的@EnableSwaggerMgUi、实现MgStorageService才可使用,且已是zyplayer-doc-swagger项目的代码同步了。
  • 建议关注和使用zyplayer-doc-swagger项目,定位于所有文档的管理,而不只是一个前端ui,spring-boot项目,直接可使用,集成spring security、mybatis plus等,对接口、页面具有权限控制,此项目开发不久,文档那些尚未完善,欢迎有想法的人一起来写

每一行代码都是从头开始写的,所以每一个问题都能及时得到解决

欢迎多多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天才能写完,但前端两天就写好了,急需数据看效果,这时就让他们自己去设置模拟值,加上参数自己测试好。 而不是一味的催后台,把各种锅丢给后端,然后玩自己的去了,浪费各环节等待时间。

↑↑以上个性化功能在demo中都有写到,欢迎体验↑↑:

如果需要看多个项目的文档,不再需要对让被访问的项目支持跨域访问!因为已集成服务器端代理请求,想请求什么都行!把在线调试当postman来用都行!(虽然功能差得远,但基础的用是没问题的,够用就行,不断完善中)

功能细节:

  1. 支持添加多个文档,同时展示
  2. 左侧的侧边栏支持左右拖动改变大小
  3. 优化各种细节,做到能不展示就不展示
  4. 服务器端的存储能力
  5. 模拟请求过滤能力
  6. 请求参数缓存能力
  7. 更多细节等你发现

软件架构

maven项目,前端由html、js、css组成的,后端使用java,前端框架使用的zui

建议:

  1. 单项目文档不要添加@EnableSwaggerMgUi注解
  2. 多项目时建议不要引入文档UI包,只需要引入springfox-swagger2包,单独部署一个项目添加swagger-mg-ui包,增加@EnableSwaggerMgUi注解,再实现MgStorageService类,部署后用于专门的文档管理项目,再在文档页面“添加文档”,管理所有项目的文档,真正实现文档和项目分离管理!

欢迎加入群聊讨论:

QQ群

软件截图

支持添加和管理任意swagger文档地址:

多分文档时可选择只展示某一个文档:

多种展示方式:

在线调试支持单行和多行编辑模式:

文档展示页面:

在线调试页面:

模拟返回页面:

导出文档:

复制文档内容:

独立文档查看:

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2018 暮光:城中城 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

swagger-mg-ui是swagger的一个前端实现,使用简单、解析速度快、走心的设计,支持文档导出和多项目同时展示,多种文档目录的展示方案,多种自定义配置,满足各种使用习惯 展开 收起
HTML
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
HTML
1
https://gitee.com/dych/swagger-mg-ui.git
git@gitee.com:dych/swagger-mg-ui.git
dych
swagger-mg-ui
swagger-mg-ui
master

搜索帮助

14c37bed 8189591 565d56ea 8189591