Java中Spring Boot框架集成Swagger2增强版Knife4j

我会带着你远行 2024-03-27 10:21 87阅读 0赞

![40006e0de2c744a28eefc162b218666a.png][]

**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.3.5.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-spring-boot-fast-demo</artifactId>
        <version>1.0</version>
        <name>knife4j-spring-boot-fast-demo</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
                <version>2.0.9</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

**第一步：在maven项目的`pom.xml`中引入Knife4j的依赖包，代码如下：**

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

**第二步：创建Swagger配置依赖，代码如下：**

@Configuration
    @EnableSwagger2WebMvc
    public class Knife4jConfiguration {
    
        @Bean(value = "defaultApi2")
        public Docket defaultApi2() {
            Docket docket=new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(new ApiInfoBuilder()
                            //.title("swagger-bootstrap-ui-demo RESTful APIs")
                            .description("# swagger-bootstrap-ui-demo RESTful APIs")
                            .termsOfServiceUrl("http://www.xx.com/")
                            .contact("xx@qq.com")
                            .version("1.0")
                            .build())
                    //分组名称
                    .groupName("2.X版本")
                    .select()
                    //这里指定Controller扫描包路径
                    .apis(RequestHandlerSelectors.basePackage("com.github.xiaoymin.knife4j.controller"))
                    .paths(PathSelectors.any())
                    .build();
            return docket;
        }
    }

**最终整个工程目录结构如下图：**

![b1745376c622454b8227afad4145e915.png][]

**`IndexController.java`包含一个简单的RESTful接口,代码示例如下：**

@Api(tags = "首页模块")
    @RestController
    public class IndexController {
    
        @ApiImplicitParam(name = "name",value = "姓名",required = true)
        @ApiOperation(value = "向客人问好")
        @GetMapping("/sayHi")
        public ResponseEntity<String> sayHi(@RequestParam(value = "name")String name){
            return ResponseEntity.ok("Hi:"+name);
        }
    }

**此时，启动Spring Boot工程，在浏览器中访问：`http://localhost:17790/doc.html`**

**![87e4064abb134118bdcd69090aa87e9a.png][]**

官网地址:[Knife4j · 集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4j (xiaominfo.com)][Knife4j _ _Swagger2_OpenAPI3_. _ Knife4j _xiaominfo.com]

[40006e0de2c744a28eefc162b218666a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/cb28ab92d1434c7193d3021829bc08bd.png
[b1745376c622454b8227afad4145e915.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/b3686b836469441f98f5cbdd0bc22d97.png
[87e4064abb134118bdcd69090aa87e9a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/466fb8b47a1b4c39aa99bf85c40a4002.png
[Knife4j _ _Swagger2_OpenAPI3_. _ Knife4j _xiaominfo.com]: https://doc.xiaominfo.com/