若依后端添加子模块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类。
名称不用修改,建议直接从别的地方复制过来。
只需要修改类中的包路径即可。