关于java:颜值绝绝子的-swaggerui

3次阅读

共计 1253 个字符,预计需要花费 4 分钟才能阅读完成。

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…

正文完
 0