springboot swagger 接口文档分组展示

news2024/11/18 11:38:59

例如将 controller 分成四类,分别放到四个包下:

        

xxx.xxx.xxx.controller.manage
xxx.xxx.xxx.controller.client
xxx.xxx.xxx.controller.authority
xxx.xxx.xxx.controller.common
SwaggerConfig.java:
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

@RefreshScope
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Value("${system.swagger_show}")
    private boolean swaggerShow;

   
     @Bean
    public Docket manageGroup() {
        return this.buildDocket( "管理端接口","xxx.xxx.xxx.controller.manage" );
    }

    @Bean
    public Docket clientGroup() {
        return this.buildDocket( "移动端接口","xxx.xxx.xxx.controller.client" );
    }

    @Bean
    public Docket authorityGroup() {
        return this.buildDocket( "权限相关接口","xxx.xxx.xxx.controller.authority" );
    }

    @Bean
    public Docket commonGroup() {
        return this.buildDocket( "数据字典、行政区域公共接口","xxx.xxx.xxx.controller.common" );
    }

    private Docket buildDocket( String groupName,String basePackage ){
        return new Docket(DocumentationType.SWAGGER_2)
                    .groupName( groupName )
                    .enable(this.swaggerShow)
                    .produces(Collections.singleton(MediaType.APPLICATION_JSON_VALUE))
                    .genericModelSubstitutes(ResponseEntity.class)
                    .forCodeGeneration(false)
                    .useDefaultResponseMessages(false)
                    .pathMapping("/")
                    .select()
                    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    .apis(RequestHandlerSelectors.basePackage( basePackage ))
                    .paths(PathSelectors.any())
                    .build()
                    .globalOperationParameters( setHeaderToken() )
                    .directModelSubstitute(java.sql.Timestamp.class, java.sql.Date.class)
                    .apiInfo(apiInfo());
    }

    private List<Parameter> setHeaderToken() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("witToken").description("登录token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        return pars;
    }

    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("xxx系统( xxx) API")
                .description("xxx系统( xxx) API")
                .license(null)
                .licenseUrl(null)
                .contact(new Contact("developer", "", "developer@xxx.com"))
                .version("1.0")
                .build();
        return apiInfo;
    }

}

效果:

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1548142.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

java ssh 电影院购票管理系统eclipse开发mysql数据库MVC模式java编程网页设计

一、源码特点 JSP ssh 电影院购票管理系统是一套完善的web设计系统&#xff08;系统采用ssh框架进行设计开发&#xff09;&#xff0c;对理解JSP java编程开发语言有帮助&#xff0c;系统具有完整的源代码和数据库&#xff0c;系统主要采用 B/S模式开发。开发环境为TOMCAT…

集成学习 | 集成学习思想:Stacking思想

目录 一. Stacking 思想 一. Stacking 思想 Stacking(或stacked generalization)&#xff0c;是指训练一个模型用于组合(combine)其他各个模型 Stacking有两层第一层是不同的基学习器&#xff08;classifiers/regressors&#xff09;第二层是用于组合基学习器的元学习&#xf…

全选和取消全选

html <table><thead><tr><th><el-checkbox change"check" v-model"checkAll">全选/取消</el-checkbox></th></tr></thead><tbody><tr v-for"(item, index) in tableData" :ke…

最新的Flutter3.x版本获取应用包名的方法

以前的flutter项目可以在 AndroidManifest.xml 中获取应用包名&#xff0c; 最新的Flutter3.x版本要获取应用包名可以找到build.gradle 更多内容参考&#xff1a;最新的Flutter3.x版本如何获取应用包名

Git学习笔记之基础

本笔记是阅读《git pro》所写&#xff0c;仅供参考。 《git pro》网址https://git-scm.com/book/en/v2 git官网 https://git-scm.com/ 一、git起步 1.1、检查配置信息 git config --list查看所有的配置以及它们所在的文件 git config --list --show-origin可能有重复的变量名…

HarmonyOS(鸿蒙开发)入门篇

如果需要学习鸿蒙开发可以查看以下学习资源链接 OpenAtom OpenHarmony Develop applications - HUAWEI HarmonyOS APP 转载请注明出处HarmonyOS(鸿蒙开发&#xff09;入门篇-CSDN博客&#xff0c;谢谢&#xff01;

05.循环

格式&#xff1a; 05.循环 01.循环语句02.while循环1.1while循环1.2.死循环1.3 while循环应用 计算123。。。100的和 03.for循环&#xff08;迭代循环&#xff09;3.1 基本格式3.2 range() 04.break和continue关键字4.1 break4.2 continue 01.循环语句 02.while循环 03.for循环…

【MySQL】聊聊自增id用完怎么办?

在实际的开发中&#xff0c;一般都会将数据存储到数据库中&#xff0c;在设计表的时候&#xff0c;其实id如果达到最大值的话&#xff0c;会出现什么问题。其实主要分两种情况&#xff0c;一种是设置了主键id&#xff0c;另一种没有设置主键id。 表定义自增值id create table…

QT_day4:对话框

1、完善对话框&#xff0c;点击登录对话框&#xff0c;如果账号和密码匹配&#xff0c;则弹出信息对话框&#xff0c;给出提示”登录成功“&#xff0c;提供一个Ok按钮&#xff0c;用户点击Ok后&#xff0c;关闭登录界面&#xff0c;跳转到其他界面 如果账号和密码不匹配&…

探索未知的精彩——揭秘你不知道的10个Excel操作技巧

Excel&#xff0c;这个广受欢迎的电子表格软件&#xff0c;在办公、数据处理和统计分析等领域发挥着重要作用。然而&#xff0c;除了常见的基础功能外&#xff0c;Excel还拥有许多隐藏的操作技巧&#xff0c;可以让您更高效地处理数据、优化工作流程。在本文中&#xff0c;我们…

【c++】类和对象(四)深入了解拷贝构造函数

&#x1f525;个人主页&#xff1a;Quitecoder &#x1f525;专栏&#xff1a;c笔记仓 朋友们大家好啊&#xff0c;本篇内容带大家深入了解拷贝构造函数 目录 1.拷贝构造函数1.1传值调用的无限调用1.2浅拷贝1.3深拷贝1.4深拷贝的实现 1.拷贝构造函数 拷贝构造函数是一种特殊的…

解决华为云服务器宝塔面板无法访问显示“此站点的连接不安全”问题

已经配置好安全组以及初始化宝塔面板&#xff0c;还是无法访问镜像管理页面&#xff0c;提示此站点的连接不安全。 解决方案 将地址https改为http即可进入。 成功登录后&#xff0c;开启面板SSL即可。

武汉星起航:亚马逊卖家运营新指南,爆款品类揭秘

随着全球电商市场的蓬勃发展&#xff0c;亚马逊作为领先的在线零售平台&#xff0c;为卖家提供了无限的商机。然而&#xff0c;在浩如烟海的商品中&#xff0c;如何选择低风险、高回报的产品&#xff0c;成为每个亚马逊卖家关注的焦点。近日&#xff0c;武汉星起航凭借其深厚的…

Redis 教程系列之Redis PHP 使用 Redis(十二)

PHP 使用 Redis 安装 开始在 PHP 中使用 Redis 前&#xff0c; 我们需要确保已经安装了 redis 服务及 PHP redis 驱动&#xff0c;且你的机器上能正常使用 PHP。 接下来让我们安装 PHP redis 驱动&#xff1a;下载地址为:https://github.com/phpredis/phpredis/releases。 P…

index.js:235 uView提示:maxDate不能小于当前时间

组件不合理的提示。我就是不想让他maxDate选择未来时间。 需求&#xff1a;用uview的calendar做一个时间段的选择&#xff0c;当设置maxDate为今天&#xff0c;遇到这个无理的提示。 1、找到calendar组件源码提示位置 2、注释掉这段代码 3、看效果 我的代码 <template>…

【线段树二分】第十三届蓝桥杯省赛C++ A组/研究生组 Python 研究生组《扫描游戏》(C++)

【题目描述】 有一根围绕原点 O 顺时针旋转的棒 OA&#xff0c;初始时指向正上方&#xff08;Y 轴正向&#xff09;。 在平面中有若干物件&#xff0c;第 i 个物件的坐标为&#xff08;,)&#xff0c;价值为 。 当棒扫到某个物件时&#xff0c;棒的长度会瞬间增长 &#xff…

FreeRTOS的介绍

FreeRTOS介绍 本文主要涉及RTOS的相关内容 1.RTOS与裸机的区别 2.RTOS的架构与特点 3.任务调度 4.任务状态 文章目录 FreeRTOS介绍一、RTOS与裸机的区别二、FreeRTOS 简介2.1 特点2.2 架构2.3 应用领域总结 三、 任务调度3.1 基本原理3.2 调度策略3.3 实现方式 四、 任务状态 一…

spring cloud 限流熔断配置

springcloud 微服务网关 zuul.strip-prefixtrue zuul.routes.postgres-client.path /ps01/** zuul.routes.postgres-client.service-idpostgres-client zuul.routes.postgres-client02.path/ps02/** zuul.routes.postgres-client02.service-idpostgres-client02 zuul.semaphor…

主流公链 - BSC

探索Binance Smart Chain (BSC) 区块链&#xff1a;实现高性能的智能合约平台 1. BSC 简介 Binance Smart Chain (BSC)是由全球领先的加密货币交易平台币安&#xff08;Binance&#xff09;推出的智能合约平台。它旨在为开发者提供高性能、低成本的区块链基础设施&#xff0c;…

助力福建新型职业农民培育 北方天途推进无人机植保应用培训

为加强新型职业农民的职业培育&#xff0c;扩展新型农民的知识范围和专业技术水平&#xff0c;推进农业供给侧结构性改革。日前&#xff0c;在农业部门的大力支持下&#xff0c;北方天途航空和宁德天禾科技服务携手为福建省农民朋友开展了植保无人机驾驶员的应用培训。福建省农…