Swagger

1、导入knife4j的依赖

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>

2、编写配置类

package com.heima.common.knife4j;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author 星辰鱼
 * @version 1.0
 * @date 2023/5/22 18:15
 */
@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class Swagger2Configuration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //分组名称
                .groupName("1.0")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.heima"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 标题
                .title("黑马头条API文档")
                // 描述
                .description("黑马头条API文档")
                // 版本
                .version("1.0")
                .build();
    }
}

3、自动化配置

在resources创建\META-INF\spring.factories文件，并导入自动化装配配置

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.heima.common.knife4j.Swagger2Configuration

4、打注解

两个注解需要特别说明：

// controller层类上的注解 - @Api(tags = "APP用户相关接口")
@Api(tags = "APP用户相关接口")
public class ApUserLoginController
    
// 类上的方法 - @ApiOperation("用户登录")
@ApiOperation("用户登录")
@PostMapping("/login_auth")
public ResponseResult login(@RequestBody LoginDto loginDto){
    log.info("用户登录传来的参数：{}", loginDto);
    return apUserService.login(loginDto);
}

// 实体类上的注解
@ApiModel(description = "登录实体类")
public class LoginDto {

// 实体类属性上的注解
@ApiModelProperty("电话")
private String phone;

注解	说明
@EnableSwagger2	该注解是Springfox-swagger框架提供的使用Swagger注解，该注解必须加
@EnableKnife4j	该注解是knife4j提供的增强注解,Ui提供了例如动态参数、参数过滤、接口排序等增强功能,如果你想使用这些增强功能就必须加该注解，否则可以不用加

5、重启服务

6、测试

http://localhost:51801/doc.html

• 如果有拦截器，要在配置类设置静态资源映射

/**
 * 设置静态资源映射
 * @param registry
 */
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}