swagger-mg-ui

项目介绍

swagger-mg-ui是swagger的一个前端实现，使用简单、解析速度快、走心的设计，给你带来不一样的体验！

给个Star鼓励下呗！作为给作者快速更新的动力，右上角↗

如何使用

1、添加依赖

<!-- https://mvnrepository.com/artifact/com.zyplayer/swagger-mg-ui -->
<dependency>
    <groupId>com.zyplayer</groupId>
    <artifactId>swagger-mg-ui</artifactId>
    <version>2.0.0</version>
</dependency>

2、启动后访问：http://localhost:8080/document.html 即项目地址+document.html

为何要重复造轮子呢？

1. 现有UI还不够好，我觉得我能做个更好的

   官方的UI：功能全面，基本上把已有的特性都支持了，但文档查看不够友好，不支持搜索，一次性全部渲染，接口太多的时候解析速度很慢，源码云里雾里，基本看不懂也改不动。

   其他UI：前端技术老旧，还有很多一看界面和源码就知道是后端人员写的，模块不清晰，代码冗余，代码量奇高，界面看上去有一种没规划、拉垮的感觉。

   本项目1.x是用jQuery开发的，学会了Vue之后就没动力维护了，于是使用 Vue3 + Ant-design-vue 重构出了2.x版本，重构后感觉神清气爽。 新版本的代码每一行都是新敲出来的，解析速度更快，逻辑更清晰，代码更简洁，界面更清爽。

2. 有用户有这种仅需要集成一个好看UI的需求

3. 新技术总是如此的吸引人，总抵不住诱惑想去体验一番

本项目提供了哪些能力呢？

2.x版本仅为一个UI前端，无任何后端代码，以满足只想要一个好看的UI为目的单项目使用。 更多的统一化的文档管理等功能移到了zyplayer-doc 项目中了，有兴趣的同学可以去了解下。

够用还是要全套？

去详细研究了一下swagger的标准，https://swagger.io/specification/v2 ，里面的属性超级多， 如果想按照标准完全解析，我觉得很多属性根本用不上，而且测试也复杂，很容易覆盖不到。 最后权衡下来本项目的原则是有用到哪些就解析哪些属性，没必要来全套，大家一起来维护完善，共建共享。 也许某个小问题对你有影响，可以提issues，将最迟一周内解决并发布。 如果你觉得本项目和你胃口，那就坚持一下，多提意见，让它走的更远。

软件架构

使用到的前端依赖：Vue3、vue-router、vuex、ant-design-vue、axios、brace、highlight.js、jsontoxml、less、mavon-editor、moment、qs、sass、xml-formatter、...

欢迎加入群聊讨论：

界面截图

主页面

文档查看页面

在线调试页面