java-2配置swagger测试

Z编程

于 2024-12-12 01:29:51 发布

阅读量361

点赞数 8

CC 4.0 BY-SA版权

分类专栏： java学习文章标签： java 开发语言 spring

本文链接：https://blog.csdn.net/weixin_45636198/article/details/144413812

java学习专栏收录该内容

8 篇文章

订阅专栏

1.添加相关配置类

package com.atguigu.spzx.common.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class Knife4jConfig {

    @Bean
    public GroupedOpenApi userApi() {      // 创建了一个api接口的分组
        return GroupedOpenApi.builder()
        .group("user-api")         // 分组名称
        .pathsToMatch("/api/**")  // 接口请求路径规则
        .build();
    }

    @Bean
    public GroupedOpenApi adminApi() {      // 创建了一个api接口的分组
        return GroupedOpenApi.builder()
        .group("admin-api")         // 分组名称
        .pathsToMatch("/admin/**")  // 接口请求路径规则
        .build();
    }

    /***
     * @description 自定义接口信息
     */
    @Bean
    public OpenAPI customOpenAPI() {

        return new OpenAPI().info(new Info()
                                  .title("API接口文档")
                                  .version("1.0")
                                  .description("API接口文档")
                                  .contact(new Contact().name("周建豪"))); // 设定作者
    }

}

GroupedOpenApi 代表api分组

2.手动扫描swagger配置文件

因为服务的启动类在spzx-manager模块中，swagger配置文件在spzx-common模块中，这两个模块属于平级关系，springboot只会扫描启动类所在模块的子集，所以我们需要在启动类中手动扫描swagger配置文件

package com.atguigu.spzx.manager;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication
//手动扫描swagger配置类，因为swagger配置类不在当前启动类的子包中，所以需要手动扫描
@ComponentScan(basePackages = {"com.atguigu.spzx"})
public class ManagerAppliaction {
    public static void main(String[] args) {
        SpringApplication.run(ManagerAppliaction.class,args);
    }
}