专栏首页JAVA后端开发自研网关:多项目的swagger聚合功能

自研网关:多项目的swagger聚合功能

自研网关系统已开源,求star 项目地址

网关一般都会有一个swagger聚合功能,方便于你测试文档接口。 但网上的例子,如https://doc.xiaominfo.com/solution/ui-front-gateway.html#%E6%96%87%E6%A1%A3%E8%81%9A%E5%90%88%E4%B8%9A%E5%8A%A1%E7%BC%96%E7%A0%81. 这些例子都能解决swagger聚合的问题,但问题是他只支持一个项目,但我网关肯定会有多个项目,这个怎么处理呢。 其实这个原理一样,但说起来也是有几个技术难点的.

  1. doc.html路径问题: swagger默认的文档路径为doc.html或swagger-ui.html,但如果是多项目,即我这个项目,路径需要变成/项目编码/doc.html,这个怎么解决如下,如解决不当,会报404或跨域问题
@Component
public class SwaggerFilter implements WebFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
        //获取工程编码
        String projectCode= RequestHelper.getRequestProjectCode(exchange.getRequest());
        if (StringUtils.isNotEmpty(projectCode)&&projectCode.endsWith(GatewayConstant.STARMARK_SWAGGER)) {
            if (exchange.getRequest().getURI().getPath().contains(projectCode + "/doc.html")) {
                return chain.filter(exchange.mutate().request(exchange.getRequest().mutate().path("/doc.html").build()).build());

            } else if (exchange.getRequest().getURI().getPath().contains(projectCode + "/webjars/")) {
                return chain.filter(exchange.mutate().request(exchange.getRequest().mutate().path(exchange.getRequest().getURI().getPath().replace("/" + projectCode, "")).build()).build());
            }
        }


        return chain.filter(exchange);
    }

}

通过过滤器,将请求转向根请求 2.支持多项目的配置,每个请求都含项目编码,知道属于哪个项目.

@Controller
@RequestMapping()
public class SwaggerHandler {
    @Autowired(required = false)
    private SecurityConfiguration securityConfiguration;
    @Autowired(required = false)
    private UiConfiguration uiConfiguration;
    private final SwaggerProvider swaggerResources;

    @Autowired
    public SwaggerHandler(SwaggerProvider swaggerResources) {
        this.swaggerResources = swaggerResources;
    }


    @GetMapping("/{projectCode}/swagger-resources/configuration/security")
    @ResponseBody
    public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration(@PathVariable("projectCode") String projectCode) {
        return Mono.just(new ResponseEntity<>(
                Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK));
    }

    @GetMapping("/{projectCode}/swagger-resources/configuration/ui")
    @ResponseBody
    public Mono<ResponseEntity<UiConfiguration>> uiConfiguration(){
        return Mono.just(new ResponseEntity<>(
                Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
    }

    @GetMapping("/{projectCode}/swagger-resources")
    @ResponseBody
    public Mono<ResponseEntity> swaggerResources(@PathVariable("projectCode") String projectCode) {
        return Mono.just((new ResponseEntity<>(swaggerResources.get(projectCode), HttpStatus.OK)));
    }



}
@Component
@Primary
@AllArgsConstructor
public class SwaggerProvider {


    @Autowired
    private IRouteService routeService;

    public List<SwaggerResource> get(String projectCode) {
        //获取真正的projectCode
        String innerProjectCode = projectCode.replace(GatewayConstant.STARMARK_SWAGGER, "");
        List<GatewayAppDto> appDtos = routeService.getGatewayApps(innerProjectCode);

        List<SwaggerResource> resources = appDtos.stream().map(this::swaggerResource).collect(Collectors.toList());
        return resources;
    }

    private SwaggerResource swaggerResource(GatewayAppDto gatewayAppVo) {
        SwaggerResource swaggerResource = new SwaggerResource();
        swaggerResource.setName(gatewayAppVo.getAppName());
        swaggerResource.setLocation("/v2/api-docs?swagger_code="+gatewayAppVo.getAppCode());
        swaggerResource.setSwaggerVersion("2.0");
        return swaggerResource;

    }


}

这样,我返回的每个接口地址都含有一个子模块参数swagger_code 3.解决swagger_code参数带来的不显示文档的问题 现在其实已经能显示swagger聚合文档,但发现显示不全,文档接口全没有了。 经排查,是接口/v2/api-docs不允许有任何参数。 解决办法时,网关转发时,使用RemoveRequestParameter把该参数swagger_code去掉 示例如下:

  private List<FilterDefinition> createSwaggerFilterDefinition() {
        List<FilterDefinition> filterDefinitions=new ArrayList<>();
        {
            Map<String, String> args = new HashMap<>();
            args.put("name", "swagger_code");
            FilterDefinition filterDefinition = new FilterDefinition();
            filterDefinition.setName("RemoveRequestParameter");
            filterDefinition.setArgs(args);
            filterDefinitions.add(filterDefinition);
        }
        filterDefinitions.add(createFilterDefinition("1"));
        return filterDefinitions;

    }

至此,多项目的网关聚合功能已完成.

image.png

具体代码大家可以去我的开源项目中看,欢迎提ISSUE及需求。 因为只有一个人,也欢迎大家参与进来.

下期需求计划: 网关配置转发后,可能有些接口出问题,临时不允许访问,或升级时转发到另一地址,需要做url的下架,转发功能

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • activiti 自定义函数解析juel表达式

    activiti是支持juel表达式的,这个也很好用,但实际过程中需要支持类方法及变量。    原来项目中解析juel,这边有自定义一个方法的 代码如下:

    星痕
  • spring boot 集成cache时,与shiro的冲突解决

    最近想将cache 集成在项目中,原来计划上使用jetcache,但发现一直不成功.后面转成j2cache,但也是不成功.最后想基本的spring boot c...

    星痕
  • shiro单Realm实现多种登陆方式的扩展与实现

    最近考虑给自己的平台增加新的登陆方式,上网查了一下相关的资料 .我用的权限平台为shiro,如果要实现,需要实现多个Realm,我个人觉得这种方法有点麻烦,每...

    星痕
  • queue的使用

    gfu
  • 基于spring boot ftp文件上传

    对ftp文件上传将行封装,实现连接的单例模式,完成线程安全的改进,ftp文件上传下载失败的重试。

    张泽旭
  • 我为什么要选前端这条路

    随意搜索一下“如何才能成为优秀的前端开发工程师”,就能发现前端要学的东西是不可估量的

    书童小二
  • 前端大牛or架构师应该具备这些

    相信很多招聘要求上都会写明需要3-5年经验才可以达到架构师要求,并且针对其中一些必要的技术储备大家已经能够耳熟能详,那究竟为什么需要这么久时间,以及具体每项技能...

    RobinsonZhang
  • 画解算法:6. Z 字形变换

    https://leetcode-cn.com/problems/zigzag-conversion/

    灵魂画师牧码
  • EasyNVR如何自己更改web界面(网页的自定修改)

    咱们的EasyNVR的前端其实 也就是一个调用我们流媒体软件接口的demo,为了方便更改,我们也会提供2.7web页面来方便客户的参考接口的调用和自身按需的...

    EasyNVR
  • 学好前端的 6 点建议

    最近接触了很多前端的小伙伴,和他们谈了很多职业发展的问题。他们大部分是做了一到三年的前端新手。

    Phodal

扫码关注云+社区

领取腾讯云代金券