Springboot配置Swagger的實現(xiàn)示例

更新時間：2023年10月18日 11:42:33 投稿：zx

Swagger 是一種提高 API 開發(fā)和維護效率的工具,它使開發(fā)者能夠更輕松地構建、測試和文檔化 API,本文主要介紹了Springboot配置Swagger的實現(xiàn)示例,感興趣的可以了解一下

Swagger 是什么

Swagger 是一個用于構建、文檔和調用 RESTful Web 服務的強大工具。它提供了以下幾方面的好處：

自動生成 API 文檔: Swagger 可以自動生成 API 文檔，包括接口的描述、輸入?yún)?shù)、輸出參數(shù)、請求示例、響應示例等信息。這使得開發(fā)人員、測試人員和客戶端開發(fā)人員能夠輕松地理解和使用 API。

可視化交互界面: Swagger 生成的文檔通常包括一個可視化的交互界面，允許用戶測試 API 端點而無需編寫任何代碼。這簡化了開發(fā)和測試的過程。

標準化接口設計: Swagger 鼓勵開發(fā)團隊使用標準的注解或規(guī)范來定義 API，這樣可以更容易地創(chuàng)建一致性的 API 設計。這對于多個開發(fā)團隊協(xié)同工作的大型項目特別有用。

客戶端代碼生成: Swagger 可以生成客戶端代碼，使客戶端開發(fā)人員能夠使用 API 而無需手動編寫 HTTP 請求和數(shù)據(jù)模型的代碼。這減少了代碼重復和錯誤。

減少文檔維護成本: Swagger 自動生成的文檔與實際代碼同步，因此當 API 發(fā)生更改時，文檔也會相應更新，減少了手動維護文檔的工作。

安全集成: Swagger 可以與身份驗證和授權機制集成，幫助開發(fā)人員更輕松地確保 API 的安全性。

代碼注釋: 使用 Swagger 注解，可以更清晰地記錄 API 的用途、參數(shù)、響應等信息。這有助于提高代碼的可維護性。

Swagger配置springboot

代碼展示

添加 Maven 依賴：首先，在你的 Spring Boot 項目的 pom.xml 文件中，添加 Swagger2 依賴。以下是一個示例：

<?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.5.6</version> <!-- 使用正確的版本號 -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>swaggerdemo01</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>swaggerdemo01</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>



        <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>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.vaadin.external.google</groupId>
            <artifactId>android-json</artifactId>
            <version>0.0.20131108.vaadin1</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>2.0.32</version>
            <scope>compile</scope>
        </dependency>


    </dependencies>


</project>

創(chuàng)建 Swagger 配置類：在你的項目中創(chuàng)建一個配置類，通常命名為 SwaggerConfig，并添加 @Configuration 注解。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
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 createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.swaggerdemo.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("雷達數(shù)據(jù)修正算法相關接口")
                        .description("雷達數(shù)據(jù)修正算法邏輯展示")
                        .version("9.0")
                        .contact(new Contact("z s","blog.git.net"," "))
                        .license("The Apache License")
                        .licenseUrl("http://www.s t.com/")
                        .build());
    }
}

啟用 Swagger：在你的 Spring Boot 應用程序主類上添加 @EnableSwagger2 注解。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class Swaggerdemo01Application {

    public static void main(String[] args) {
        SpringApplication.run(Swaggerdemo01Application.class, args);
    }

}

編寫 API 文檔注釋：在你的控制器類和方法上使用 Swagger 注解編寫接口文檔的注釋，包括參數(shù)、響應等信息。示例：

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Api(tags = "示例控制器")
public class AccountController {

    @GetMapping("/hello")
    @ApiOperation("獲取歡迎消息")
    public String hello() {
        return "Hello, World!";
    }
}

訪問 Swagger UI：啟動你的應用程序后，你可以通過瀏覽器訪問 Swagger UI，通常在 http://localhost:8080/swagger-ui.html。

這些步驟將幫助你在 Spring Boot 項目中整合 Swagger，以便生成和展示 API 文檔。你可以根據(jù)你的項目需求和喜好進行更多的配置和定制。