采用 Vue 编写的功能强大的 Swagger-ui 页面

本人花费半年的时间总结的《Java面试指南》已拿腾讯等大厂offer,已开源在github ,欢迎star!

转载声明:转载请注明出处,本技术博客是本人原创文章

本文GitHub https://github.com/OUYANGSIHAI/JavaInterview 已收录,这是我花了6个月总结的一线大厂Java面试总结,本人已拿大厂offer,欢迎star

原文链接:blog.ouyangsihai.cn >> 采用 Vue 编写的功能强大的 Swagger-ui 页面

点击上方 **好好学java **,选择 **星标 **公众号


重磅资讯、干货,第一时间送达


今日推荐:20207月程序员工资统计,平均14357元,又跌了,扎心个人原创100W+访问量博客:点击前往,查看更多

swagger-ui有非常多的版本,觉得不太好用,用 postman,每个接口都要自己进行录入。所以在基于 think-vuele进行了 swagger格式 json的解析,自己实现了一套swaggerui界面。

swagger分为后端数据提供方方和前端页面展示请求方。从一定角度来看,swagger是一种标准的数据格式的定义,对于不同语言进行实现一些注解API式的东西,能快速生成这种描述 restful格式的 api信息的 json串.

此项目模块依赖于  think-vuele

demo:http://sw.tennetcn.com

github:

https://github.com/chfree/think-swagger-ui-vuele

使用方式

自行下载编译


// 下载代码
git clone https://github.com/chfree/think-swagger-ui-vuele

// 安装依赖
npm install

// 直接运行
npm run dev

// 打包
npm run build

java项目 maven直接依赖


<dependency>
  <groupId>com.tennetcn.free</groupId>
  <artifactId>think-swagger-ui-starter</artifactId>
  <version>0.0.4</version>
</dependency>

此jar包的开源项目为 think-free-base中的子项目模块

登陆

登陆界面分为 json模式和 swagger请求地址访问,没多大区别,只有拿到标准的 swagger json数据即可。

支持两种主题,一种是后端管理系统模式的主题。另外一种也是类似,中间1024px进行居中,两边留白。

主页

对于我使用过的一个版本的 swagger来说,当接口数量在 1000+以上,会等的时间非常长,原因是他一次将所有接口数据进行解析渲染,这个就是慢的原因。

所以我将此进行优化,改为先解析出 api摘要信息,然后在点击摘要的时候进行请求头、请求体的渲染;基本可以做到秒开

可以自动填充非 json请求体的数据,采用的是 mock.Random

对于json请求体的数据,可以进行 json格式化编辑,也是非常方便。 json在线格式化编辑使用的是 josdejong大神的 jsoneditor

对于响应数据直接采用 json格式化组件进行格式化展示,支持展开层级。再也不用将返回的数据在去找相关的 json格式化工具进行格式化了。格式化控件采用的是 chenfengjw163大神的 vue-json-viewer

设置

在后端api请求的时候,一般都会在请求头中带一些token的验证,来进行用户标识,所以在设置中,进行了自定义请求头的设置,可以方便的设置相关的请求头,在任何一个请求都会自动带上设置的请求信息。

swagger 信息展示

来源于后端swagger配置的相关信息在此处进行展示

最后,再附上我历时三个月总结的 Java 面试 + Java 后端技术学习指南,笔者这几年及春招的总结,github 1.4k star,拿去不谢!

下载方式

1. 首先扫描下方二维码

2. 后台回复「Java面试」即可获取

原文地址:https://sihai.blog.csdn.net/article/details/109465811

本人花费半年的时间总结的《Java面试指南》已拿腾讯等大厂offer,已开源在github ,欢迎star!

转载声明:转载请注明出处,本技术博客是本人原创文章

本文GitHub https://github.com/OUYANGSIHAI/JavaInterview 已收录,这是我花了6个月总结的一线大厂Java面试总结,本人已拿大厂offer,欢迎star

原文链接:blog.ouyangsihai.cn >> 采用 Vue 编写的功能强大的 Swagger-ui 页面


 上一篇
Spring Boot内存泄露,排查竟这么难! Spring Boot内存泄露,排查竟这么难!
来源:http://suo.im/5MABXL 背景为了更好地实现对项目的管理,我们将组内一个项目迁移到MDP框架(基于Spring Boot),随后我们就发现系统会频繁报出Swap区域使用量过高的异常。笔者被叫去帮忙查看原因,发现配置了4
2021-04-04
下一篇 
面试官扎心一问——数据量很大,分页查询很慢,有什么优化方案? 面试官扎心一问——数据量很大,分页查询很慢,有什么优化方案?
点击上方 **好好学java **,选择 **星标 **公众号 重磅资讯、干货,第一时间送达 今日推荐:2020年7月程序员工资统计,平均14357元,又跌了,扎心个人原创100W+访问量博客:点击前往,查看更多 来源:cnblog
2021-04-04