wagger注册中心+swagger离线访问方案

小郝不负流年
小郝不负流年   + 关注
2022-08-27 11:35:30   阅读172   评论0

常规的swagger必须要应用服务在启动状态才能访问,很多时候由于服务端在发布,前端开发同事就不能查看接口文档了。

基于此背景,经过一番调研和思考,有了下面的wagger注册中心+swagger离线访问方案(说明一下这里是用的springfox 2.x)

一、首先分析

1、swagger-ui 主要调用2个接口拿数据

1)/swagger-resources  获取接口组列表

2)/v2/api-docs  获取对应组的接口信息

2、文档聚合模式

1)常见的是gateway聚合,前端访问 gateway访问的文档地址,然后gateway将请求转发到对应的微服务获取数据;

二、方案

1、建立一个swagger注册中心,可以是gateway,也可以是任意一个服务;

2、每个服务启动完成后查询本服务的Swagger信息,调用接口自动上报给swagger注册中心;

3、swagger注册中心接收各微服务上班的swagger信息数据,并做存储;

4、前端直接访问swagger注册中心获取数据,不用再讲过个各微服务。

三、核心代码

1、获取Swagger信息


  1. private Swagger getSwagger() {  
  2.     Swagger swagger = null;  
  3.     if (serviceModelToSwagger2Mapper != null && documentationCache != null) {  
  4.         Documentation documentation = documentationCache.documentationByGroup(hscSystemPropertiesProvider.getApplicationDesc());  
  5.         if (documentation != null) {  
  6.             swagger = serviceModelToSwagger2Mapper.mapDocumentation(documentation);  
  7.         }  
  8.     }  
  9.     return swagger;  
  10. }  

2、将Swagger信息序列化并上报注册中心


  1. SwaggerRegisterInfoDto swaggerRegisterInfoDto = new SwaggerRegisterInfoDto();  
  2. swaggerRegisterInfoDto.setSwaggerName(hscSystemPropertiesProvider.getApplicationDesc());  
  3. swaggerRegisterInfoDto.setSwaggerContent(jsonSerializer.toJson(swagger).value());  
  4. registerationPortal.registerSwaggerInfo(session, swaggerRegisterInfoDto);  

3、Swagger注册中心定义接口接收数据并存储到数据库

数据库核心字段就2个: name、content,name唯一。

4、前端访问改造

1)前端获取接口组列表 需要接口实现重写

分析/swagger-resources源码,我们想要从数据库获取注册的组列表,需要重新实现SwaggerResourcesProvider 接口,主要要标记@Primary以覆盖默认的。

2)前端获取接口详情

默认是调用的/v2/api-docs?group=xx,其实就是访问的上一步返回的接口组列表的地址,这里可以根据实际情况修改地址;然后注册中心收到此请求就查询数据库返回content。

根据实际情况,可以启用缓存,毕竟这个数据不经常更新。甚至有需求的还可以做版本控制,对微服务多次上报注册的swagger信息分版本记录。

对我有用,我要     转载  
文章分类: 架构  
所属标签: swager  
  • 0条评论
  • 只看作者
  • 按时间|按热度
  • 由于本人多次涉及需要打印这个证明,而每次都会忘记入口,在网上各种搜索各种摸索很是浪费时间。故本次将操作流程整理记录下来,以备忘。同时也分享给大家。1、打开湖北政务服务网,地址:http://zwfw.hubei.gov.cn/s/index.html2、切换区域到“武汉市”3、在“特色服务”模块找到“(个人)武汉市社会保险公共服务平台”4、进入“(个人)武汉市社会保险公共服务平台”,登录账号密码<imgsrc="https://cdnstatic.hoscen.cn/blog/article/184053017752895488/img/497065960be44747825acb86a17483c1.png"style=
  • 如何使用postman模拟http发送xml参数报文的POST请求?1、postman工具通过安装软件或使用谷歌插件都可以,这里不再赘述。2、配置postman,选择POST,填写URL;切换到Headers,添加Content-Type:text/xml 3、切换到body,选择raw,XML,下方填写你的请求报文4、点击Send发送请求,如图可以看到响应状态、时间、结果等信息5、讲到这里就结束了,是不是学会了?快去试试吧!
  • 解决办法:是idea的加载有问题,关闭IDEA,在工程的根目录下删除.idea文件,重新打开IDEA加载就好了。
  • Failedtoloadprojectconfiguration:cannotparsefileF:/xx/.idea/modules.xml:ParseErrorat[row,col]:[1,1]Message:文件提前结束。解决办法:关闭idea,删掉这个文件,重新打开idea
  • java中的注解@Generated用来标注源代码中的某些东西是由某些工具生成的,而不是人写的。这个注解可以用于:包、类、注解类、方法、构造方法、变量、本地变量、方法参数。
  • 目录:1、安装node.js环境2、安装cnpm3、安装vue-cli脚手架构建工具4、用vue-cli构建项目5、安装项目所需的依赖6、项目运行7、项目打包1、安装node.js环境下载地址:https://nodejs.org/zh-cn/安装过程没有太多好说的,安装完成后 win+R打开命令行输入node -v , 如图,出现版本号说明安装成功。npm包管理器是集成在node中的 , npm -v可以查看版本2、安装cnpm由于有些npm有些资源被屏蔽或者是国外资源的原因,经常会导致用npm安装依赖包的时
  • 建立服务器内网其他IP端口的隧道,可以将远程的服务映射到本地进行访问。finalshell配置隧道方法:
  • 上传图片微服务网关报错:UT000054:Themaximumsize1048576foranindividualfileinamultipartrequestwasexceeded原因:所用容器对文件的限制一般项目用的是spring 对spring参数进行配置即可spring:servlet:multipart:#MultipartPropertiesmax-request-size:10MB#总文件大小max-file-size:10MB#单个文件大小注意如果是nginx代理配置限制,报错信息里面会标记nginx。届时需要设置nginx在server_name下加上client_max_body_size20m;
  • 很多时候我们需要Linux服务器定时去运行一个脚本来触发一个操作,比如写缓存数据到硬盘、定时备份、定时重启服务、定期清除日志等。下面就简单讲解一下Linuxcrontab命令如何实现自动循环执行shell脚本。一、准备shell脚本比如我们准备一个hello.shvim/hcn/sh/hello.sh#!/bin/bash  DATETIME=$(date"+%Y%m%d%H%M%S") echo"hello, www.hoscen.cn,时间:${DATETIME}"  通过chmod命令赋予该脚本的执行权限chmod755hello.sh测试正确性二、开启crontab服务 linux应该都有crontab,没有的话可以安装一下:yuminstall vixie-cronyuminstall crontabsvixie-cron软
  • 本文讲触发el-dialog前动态修改窗口title的方法。1、el-dialog添加title属性el-dialog :title="titleType+'菜单'" :visible.sync="dialogVisible" width="800px" >el-dialog>  2、初始化变量(titleType,名称自己定义)export&