zoukankan      html  css  js  c++  java
  • 采用vue编写的功能强大的swagger-ui页面

    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/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请求地址访问,没多大区别,只有拿到标准的swaggerjson数据即可。

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

    swagger_login

    主页

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

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

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

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

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

    swagger_simple

    swagger_edit_json

    swagger_custom_field

    swagger_admin

    设置

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

    swagger_common_setting

    swagger 信息展示

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

  • 相关阅读:
    归并排序处理复杂对象例子
    Java归并排序的递归与非递归实现
    Java实现一个双向链表的倒置功能
    Node<T> 的作用
    Tomcat控制台总是打印日志问题的解决办法
    git回滚部分文件到某个版本
    ios-deploy was not found
    Ionic3的http请求如何实现token验证,并且超时返回登录页
    Ionic开发遇到的坑整理
    使用gradle命令代替CUBA Studio,启动项目
  • 原文地址:https://www.cnblogs.com/RegicideGod/p/12598278.html
Copyright © 2011-2022 走看看