若依后端添加子模块swagger分区

前言:

因为接口太多无法快速的找到对应模块的接口swagger文档,所以在对应需要隔离显示的子模块的swagger接口配置。

1、XXXWebConfiguration类配置

例:system模块

需要在controller包的同级目录下创建 framework.web.config.XXXWebConfiguration类。类的代码如下所示:

其中XXX根据自己的需要 自己命名模块名即可。

swagger显示的模块名,即根据自己的需求定义的在swagger中显示的分区名。

package cn.iocoder.yudao.module.system.framework.web.config;

import cn.iocoder.yudao.framework.swagger.config.YudaoSwaggerAutoConfiguration;
import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * XXX 模块的 web 组件的 Configuration
 *
 * @author 芋道源码
 */
@Configuration(proxyBeanMethods = false)
public class XXXWebConfiguration {

    /**
     * system 模块的 API 分组
     */
    @Bean
    public GroupedOpenApi xxxGroupedOpenApi() {
        return YudaoSwaggerAutoConfiguration.buildGroupedOpenApi("swagger显示的模块名");
    }

}

2、package-info.java

需要在controller包的同级目录下创建 framework.web包下创建package-info类。

名称不用修改,建议直接从别的地方复制过来。

只需要修改类中的包路径即可。

3、swagger效果展示

  • 8
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值