swagger文档接口根据包分组配置

最新推荐文章于 2024-07-08 07:45:00 发布

karry0130

最新推荐文章于 2024-07-08 07:45:00 发布

阅读量384

点赞数 5

分类专栏： Java常用工具文章标签： java idea swagger

本文链接：https://blog.csdn.net/weixin_43739877/article/details/138211294

版权

Java常用工具专栏收录该内容

9 篇文章 0 订阅

订阅专栏

文章目录

一、引言
二、配置
- 2.1 原本配置及效果
- 2.2 更改后配置及效果
三、结束

一、引言

关于接口文档的详细配置可参见文章API文档生成工具-----Knife4j的详细介绍、配置及应用
此文章是基于已经完成基础配置的前提下,如何根据不同包进行分组

二、配置

2.1 原本配置及效果

原本配置

/**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("苍穹外卖项目接口文档")
                .version("2.0")
                .description("苍穹外卖项目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))  //扫描了controller下所有类
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

原本效果
在这里插入图片描述

2.2 更改后配置及效果

更改后配置

/**
     * 通过knife4j生成接口文档-管理端
     * @return
     */
    @Bean
    public Docket docket1() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("苍穹外卖项目接口文档")
                .version("2.0")
                .description("苍穹外卖项目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("管理端接口")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sky.controller.admin"))  //只扫描admin文件夹
                .paths(PathSelectors.any())
                .build();

        return docket;
    }

    /**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket2() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("苍穹外卖项目接口文档")
                .version("2.0")
                .description("苍穹外卖项目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("用户端接口")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sky.controller.user"))  //只扫描user文件夹
                .paths(PathSelectors.any())
                .build();

        return docket;
    }