若依自定义服务配置swagger文档

最新推荐文章于 2024-09-13 16:02:53 发布

卡伦啊

最新推荐文章于 2024-09-13 16:02:53 发布

阅读量3.2k

点赞数

分类专栏： java 文章标签： postman eureka java

本文链接：https://blog.csdn.net/csdnkalunren/article/details/116304150

版权

本文介绍如何在Swagger中调试自定义接口。通过分析源码并在GatewayProperties中添加配置，然后在Nacos中更新设置，可以实现Swagger-UI的自定义。推荐使用第三方维护的UI，它提供更清晰的注释和更人性化的文档。此外，还需要在自定义服务的pom.xml、主类和Nacos配置中进行相应调整，并在接口方法和入参上添加注释。完成这些步骤后，将能在Swagger界面上看到自定义服务的接口文档。

摘要由CSDN通过智能技术生成

我们想要在swagger中直接调试自己的接口

通过分析源码可得具体添加 spec的代码如下在gatewayProperties这个对象中

package com.ruoyi.gateway.config;
/**
 * 聚合系统接口
 * 
 * @author ruoyi
 */
@Component
public class SwaggerProvider implements SwaggerResourcesProvider
{
    @Override
    public List<SwaggerResource> get()
    {
        List<SwaggerResource> resourceList = new ArrayList<>();
        List<String> routes = new ArrayList<>();
        // 获取网关中配置的route
        routeLocator.getRoutes().subscribe(route -> routes.add(route.getId()));
        gatewayProperties.getRoutes().stream()

这个对象需要在网关的nacos配置中增加如下代码

spring:
  cloud:
    gateway:
      routes:
        # APP模块
        - id: ruoyi-app
          uri: lb://ruoyi-app
          predicates:
            - Path