当前位置: 首页 > article >正文

若依后端添加子模块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效果展示


http://www.kler.cn/a/284471.html

相关文章:

  • 每日一练:二分查找-搜索插入位置
  • Spring框架之观察者模式 (Observer Pattern)
  • LeetCode【0031】下一个排列
  • qt QVideoWidget详解
  • 【Hadoop实训】Hive 数据操作①
  • 2024 kali操作系统安装Docker步骤
  • (转载)内存分配器101——写一个简单的内存分配器
  • SOA通信中间件介绍(一)
  • 某视频云平台存在未授权窃取用户凭据漏洞
  • Es6的let实现原理——代码解析
  • 曾黎登八月《费加罗Figaro》封面:湿发造型魅力大开
  • 风控建模流程一张图
  • 关于武汉芯景科技有限公司的实时时钟芯片XJ8337开发指南(兼容DS1337)
  • 二叉树的相关oj题目 — java实现
  • vben:对话框组件
  • 2024年8月30日(docker部署project-exam-system系统 并用Dockerfile构建java镜像)
  • 西安电子科技大学研究生新生大数据
  • 深入解析Nginx负载均衡中的`down`指令及其应用
  • SPR系列单点激光雷达测距传感器|模组之CAN-OPEN软件调试说明
  • 全网首发Windows 系统中常用的巡检命令和 CMD 命令
  • linux访问github网速太慢 the remote end hung up unexpectedly问题
  • Docker Compose 部署 Kafka的KRaft模式 不用依赖 Zookeeper
  • 跟《经济学人》学英文:2024年08月31日这期 How Abercrombie Fitch got hot again
  • 72 华为资源库
  • 第十六章 rust命令行工具开发实践
  • Django orm 中设置读写分离