springboot2.2.5.RELEASE版本整合knife4j 3.0.3版本

一、pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.yy</groupId>
    <artifactId>demo10</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo10</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-ui</artifactId>
            <version>3.0.3</version>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

二、knife4j config配置文件

package com.yy.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author yy
 * @date 2022/7/12 23:39
 */
@Configuration
@EnableSwagger2
@EnableOpenApi     //开启 Swagger3，可以不写
@EnableKnife4j     //开启 knife4j，可以不写
public class Knife4jConfig {
    
    @Bean(value = "defaultApi3")
    public Docket defaultApi3() {

        // Swagger 2 使用的是：DocumentationType.SWAGGER_2
        // Swagger 3 使用的是：DocumentationType.OAS_30
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                // 定义是否开启swagger，false为关闭，可以通过变量控制
                .enable(true)
                .apiInfo(new ApiInfoBuilder()
                        .title("XXXApi接口文档")
                        .description("XXX服务平台Api接口文档")
                        .termsOfServiceUrl("http://127.0.0.1:80")
                        .contact(new Contact("作者", "地址", "邮箱或联系方式"))
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("XXX服务")
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                //这里指定Controller扫描包路径
                //.apis(RequestHandlerSelectors.basePackage("com.yy.**.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

三、接口文档访问地址

knife4j 访问地址：http://localhost:8080/doc.html
Swagger2.0访问地址：http://localhost:8080/swagger-ui.html
Swagger3.0访问地址：http://localhost:8080/swagger-ui/index.html

四、注解说明

通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。
 
@Api：修饰整个类，描述Controller的作用。
@ApiOperation：描述一个类的一个方法，或者说一个接口。
@ApiParam：单个参数描述。
@ApiModel：描述接收参数的实体对象。
@ApiProperty：用对象接收参数时，描述对象的一个字段。
@ApiResponse：HTTP响应其中1个描述。
@ApiResponses：HTTP响应整体描述。
@ApiIgnore：使用该注解忽略这个API。
@ApiError ：发生错误返回的信息。
@ApiImplicitParam：一个请求参数。
@ApiImplicitParams：多个请求参数。