think-swagger-ui-vuele

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/thi...

应用形式

自行下载编译

Copy// 下载代码git clone https://github.com/chfree/think-swagger-ui-vuele// 装置依赖npm install// 间接运行npm run dev// 打包npm run build

java我的项目 maven间接依赖

Copy<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配置的相干信息在此处进行展现

起源:https://www.cnblogs.com/Regic...