手把手教你輕鬆搭建Swagger介面文檔，實例解析大公開

Swagger是一個風行的API文檔跟互動式測試東西，它可能幫助開辟者輕鬆地創建、測試跟保護API文檔。本文將手把手教你怎樣搭建Swagger介面文檔，並供給實例剖析。

一、情況籌備

在開端之前，請確保你的開辟情況中曾經安裝了以下東西：

• Java開辟情況（JDK 1.8+）
• Maven（用於依附管理）
• 一個IDE（如IntelliJ IDEA或Eclipse）

二、創建項目

1. 利用Maven創建一個新的Spring Boot項目。
2. 在pom.xml文件中增加以下依附：

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- Swagger 依附 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
</dependencies>

1. 在src/main/java目錄下創建一個SwaggerConfig類，用於設置Swagger：

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

@Configuration
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example"))
                .paths(PathSelectors.any())
                .build();
    }
}

1. 在src/main/resources目錄下創建一個application.properties文件，增加以下設置：

springfox.documentation.swagger2.enabled=true

三、編寫API介面

1. 在com.example包下創建一個HelloController類，用於編寫API介面：

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

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello, Swagger!";
    }
}

四、啟動項目

1. 運轉HelloController類地點的Spring Boot利用。
2. 打開瀏覽器，拜訪http://localhost:8080/swagger-ui.html。

五、實例剖析

在Swagger UI中，你可能看到以下信息：

• API基本信息：包含標題、版本、描述等。
• 介面列表：列出全部API介面及其道路、HTTP方法、參數等信息。
• 介面測試：可能直接在Swagger UI中對API介面停止測試。

六、總結

經由過程以上步調，你曾經成功搭建了一個Swagger介面文檔。在現實開辟中，你可能根據須要增加更多的API介面跟設置項。Swagger可能幫助你疾速生成、測試跟保護API文檔，進步開辟效力。