一款vue编写的功能强大的swagger-ui,有点秀(附开源地址)

swagger,基于swagger的前端UI实现 现在市面上的swagger UI不足之处 1、原生UI显示的有些不够漂亮和清晰,特别是request 的model部分 2、每个服务都需要引入一套资源文件,不能作为一个中间件为其他API使用 3、默认通用配置繁琐,每个项目都需要复制重新配置一份swagger信息 本页面替换了默认的swagger-ui,让生成的文档更加友好和美观。 要依赖swagger的注解功能,仅仅只是一个前端UI界面的实现,解析的数据来源于json/swagger.json 立即下载

作者:RegicideGod

cnblogs.com/RegicideGod/p/12598278.html

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

END
vue-swagger-ui:自定义swagger界面 vue-swagger-ui 接口文档界面 效果 立即下载

相关推荐

think-swagger-ui-vuele:招摇ui飞

think-swagger-ui-vuele swagger-ui有非常多的版本,觉得不太好用,用postman,每个接口都要自己进行录入。所以在基于think-vuele进行了swagger格式json的解析,自己实现了一套swaggerui界面。 swagger分为后端数据提供方方和前端页面展示请求方。从一定角度来看,swagger是一种标准的数据格式的定义,对于不同语言进行实现一些注解API式的东西,能快速生成这种描述restful格式的api信息的json串. 此项目模块依赖于 demo: github: 使用方式 自行下载编译 // 下载代码 git clone https://github.com/chfree/think-swagger-ui-vuele // 安装依赖 npm install // 直接运行 npm run dev // 打包 npm run build j

基于 Vue+Element 美化SwaggerUI

基于 Vue+Element 美化SwaggerUI 写在前面 本项目基于think-swagger-ui-vuele进行改造和升级,主要是修复了原项目中一些已知bug以及部分由 swagger JSON 数据不规范导致的错误,新增了部分快捷操作功能,提高使用者体验,以及改造了整个界面的风格,使其看起来更像elementUI.(这个纯属个人喜好,原作者的风格看着也挺好的,只是个人感觉灰棕色有点压抑) 原 think-swagger-ui-vuele 的体验地址:????demo 作者改造后的体验地址:??

云间月 2111

告别TwinCAT:手把手教你用IgH EtherCAT Master在LinuxCNC上搭建实时运动控制平台

本文详细介绍了如何利用IgH EtherCAT Master和LinuxCNC搭建开源实时运动控制平台,替代商业软件TwinCAT。通过分步指南,包括实时Linux环境配置、EtherCAT主站安装、LinuxCNC集成及多轴同步控制实现,帮助开发者构建高性能、低成本的工业自动化解决方案。

weixin_42641741的博客 403

采用vue编写的功能强大的swagger-ui页面

think-swagger-ui-vuele swagger-ui有非常多的版本,觉得不太好用,用postman,每个接口都要自己进行录入。所以在基于think-vuele进行了swagger格式json的解析,自己实现了一套swaggerui界面。 swagger分为后端数据提供方方和前端页面展示请求方。从一定角度来看,swagger是一种标准的数据格式的定义,对于不同语言进行实现一些...

weixin_32207033的博客 767

手把手教你用Simulink搭建DSOGI-PLL模型(附完整代码下载)

本文详细介绍了在Simulink中搭建高鲁棒性DSOGI-PLL模型的完整工程实践指南。针对传统锁相环在非理想电网下的不足,文章深入剖析了双二阶广义积分器锁相环(DSOGI-PLL)的核心原理与优势,并提供了从模块构建、系统组装到参数整定与测试验证的全流程手把手教程,附有完整代码下载,助力工程师应对谐波、电压跌落等复杂电网工况。

weixin_29223603的博客 390

车载测试工程师必备:5分钟搞定CANoe台架搭建(附DBC导入技巧)

本文为车载测试工程师提供快速搭建CANoe测试台架的实用指南,涵盖硬件连接、DBC文件导入及常见报错解决方案。通过详细步骤和高效技巧,帮助工程师在5分钟内完成台架搭建,提升车载测试效率,特别适合紧急功能验证场景。

potato的博客 815

探索 `think-swagger-ui-vuele`:优雅地集成Swagger UI于Vue应用

探索 think-swagger-ui-vuele:优雅地集成Swagger UI于Vue应用 去发现同类优质开源项目:https://gitcode.com/ 在这个API驱动的时代,API文档的重要性不言而喻。think-swagger-ui-vuele 是一个精心设计的项目,它将流行的Swagger UI与Vue.js框架结合在一起,帮助开发者在Vue应用程序中无缝集成API文档和测试工具。...

gitblog_00063的博客 557

LEC/FORMAL --- PARTIII debug

lec(logic equivalence checking)又叫formal check,是对ic design的综合,PR前后的设计进行逻辑对比检查的工具/手段,保证综合不改变rtl原始的logic function。目前用的较多的就是C家的formal工具。接下来介绍一下lec过程中遇到的问题以及debug手段。...

sinat_27691203的博客 7715

json格式生成器_Springboot OpenAPI文档生成器Swagger

一、Swagger介绍Swagger是一个开源文档生成器,可以方便的用来生成OpenAPI规格的接口文档,支持Go、Python、Haskell、Java等多种语言,同时支持在线调试接口。官网:https://swagger.ioSwagger 工具集包含:• Swagger Editor – 在线编写 OpenAPI 规范的编辑器• Swagger UI – 使用 OpenAPI 规范生成的交互...

weixin_39868034的博客 1134

【雷达图】R语言绘制雷达图(ggradar),NBA季后赛数据为例

一起用R语言给nba球星画球技雷达图吧!

池塘春草梦的博客 6252

基于MUSIC算法的DOA估计Matlab仿真

特别需要指出的是:通道与阵元并不是一一对应,通道是由空间的一个、几个或所有阵元合成的,当然空间某个特定的阵元可包含在不同的通道内。空间谱估计侧重于研究空间多传感器阵列所构成的处理系统对感兴趣的空间信号的多种参数进行准确估计的能力,其主要目的是估计信号的空域参数或信源位置,这也是雷达、通信、声纳等许多领域的重要任务之一。从系统框图中可以清晰的看出,估计空间相当于是对目标空间的一个重构过程,这个重构的精度由众多因素决定,如环境的复杂性、空间阵元的互耦、通道不一致、频带不一致等。

FPGA/MATLAB学习教程/源码/项目合作开发 1750

vue 根据swagger 生成接口_一款vue编写的功能强大的swagger-ui,有点秀(附开源地址)...

swagger-ui有非常多的版本,觉得不太好用,用postman,每个接口都要自己进行录入。所以在基于think-vuele进行了swagger格式json的解析,自己实现了一套 swaggerui 界面。swagger 分为后端数据提供方方和前端页面展示请求方。从一定角度来看,swagger 是一种标准的数据格式的定义,对于不同语言进行实现一些注解 API 式的东西,能快速生成这种描述rest...

weixin_33765593的博客 1811

重回童年的经典系列☀️| 【坦克大战3D版】游戏制作+解析

带你重回童年的经典系列——坦克大战3D版制作,感兴趣的可以看看呀~

努力前行,总会成为自己心中的那道光 5万+
上一篇: 查询亿级数据毫秒级返回!Elasticsearch 是如何做到的?
下一篇: 程序员的崩溃,是从“你薪资比我高”开始的!
Java思维导图
博客等级 码龄10年 306粉丝 71原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值