Spring Boot如何集成Swagger

要在Spring Boot項(xiàng)目中集成Swagger，請(qǐng)按照以下步驟操作：

1. 添加依賴

在你的pom.xml文件中添加Swagger和Swagger UI的依賴：

<dependencies>
    <!-- Spring Boot Starter Web, includes Spring MVC -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Swagger Core Library -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>

    <!-- Swagger UI Library -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>

    <!-- Spring Boot Starter Test, includes testing utilities -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

2. 配置Swagger

創(chuàng)建一個(gè)新的Java類(lèi)，例如SwaggerConfig.java，并添加以下代碼：

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;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo")) // 替換為你的包名
                .paths(PathSelectors.any())
                .build();
    }
}

這段代碼會(huì)啟用Swagger2，并告訴Swagger掃描指定包下的所有控制器（Controller）。

3. 創(chuàng)建API接口

在你的項(xiàng)目中創(chuàng)建一個(gè)簡(jiǎn)單的REST API接口。例如，創(chuàng)建一個(gè)名為UserController.java的文件，并添加以下代碼：

package com.example.demo;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {
    @GetMapping("/users")
    public String getUser(@RequestParam(value = "name", defaultValue = "World") String name) {
        return String.format("Hello %s!", name);
    }
}

4. 訪問(wèn)Swagger UI

啟動(dòng)你的Spring Boot應(yīng)用程序，然后在瀏覽器中訪問(wèn)http://localhost:8080/swagger-ui.html。你應(yīng)該能看到Swagger UI界面，其中列出了你的項(xiàng)目中所有可用的API接口。點(diǎn)擊任意接口，你可以查看其文檔和示例請(qǐng)求。

現(xiàn)在你已經(jīng)成功在Spring Boot項(xiàng)目中集成了Swagger。