Spring Boot整合Swagger-CSDN博客

课程名Java

内容/作用知识点/设计/实验/作业/练习

学习Java

Spring Boot整合Swagger

Swagger是一款开源的API文档生成工具可以自动扫描项目中的接口并生成API文档。在Spring Boot项目中我们可以很方便地整合Swagger为我们的API接口生成详细的文档。本文将介绍如何在Spring Boot项目中整合Swagger。

1. 添加依赖

首先我们需要在项目的pom.xml文件中添加Swagger的依赖

<dependencies>
    <!-- Swagger -->
        <!-- https://doc.xiaominfo.com/knife4j/documentation/get_start.html-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>
    <!-- 其他依赖 -->
</dependencies>

2. 创建Swagger配置类

接下来我们需要创建一个Swagger配置类用于配置Swagger的相关参数。在这个类中我们将定义一个Docket实例用于配置API的基本信息、扫描路径等。同时我们还需要定义一个@Bean方法用于返回Docket实例。代码如下

package com.jzj.scanner.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @description Knife4j 接口文档配置
 * https://doc.xiaominfo.com/knife4j/documentation/get_start.html
 * 访问地址http://localhost:8080/doc.html
 * @author 
 */
@Configuration
@EnableSwagger2
@Profile({"dev", "test"})
public class Knife4jConfig {

    @Bean
    public Docket defaultApi2() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("接口文档")
                        .description("项目名称")
                        .version("1.0")
                        .build())
                .select()
                // 指定 Controller 扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.jzj.项目包名.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

3. 访问Swagger UI页面

最后我们可以启动项目并访问Swagger UI页面。默认情况下Swagger UI页面的地址为http://localhost:8080/doc.html。在这个页面上我们可以查看到项目中所有API接口的详细信息包括请求方式、参数、响应等信息。同时我们还可以通过页面上的“Try it out”按钮对API接口进行测试。

往期专栏
Java全栈开发
数据结构与算法
计算机组成原理
操作系统
数据库系统
物联网控制原理与技术