Spring Boot 學習（12）springboot 整合 swagger2

寫在前面：最近利用晚上的時間在網上看視頻學習SpringBoot，這博客是對學習的一點點總結及記錄，技術是開源的、知識是共享的。
如果你對Spring Boot 感興趣，可以關注我的動態，我們一起學習。用知識改變命運，讓家人過上更好的生活。

相關文章：
Springboot 系列文章

---

一、Swagger2 介紹

1. Swagger2 出現的背景

現如今，前後端分離已經逐漸成爲互聯網項目一種標準的開發方式，前端與後端交給不同的人員開發，但是項目開發中的溝通成本也隨之升高，這部分溝通成本主要在於前端開發人員與後端開發人員對WebAPI接口的溝通，Swagger2 就可以很好地解決，它可以動態生成Api接口文檔，降低溝通成本，促進項目高效開發。

2. 什麼是 Swagger2

Swagger2 是一個規範和完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。

3. Swagger 的特點

• 及時性 (接口變更後，能夠及時準確地通知相關前後端開發人員)
• 規範性 (並且保證接口的規範性，如接口的地址，請求方式，參數及響應格式和錯誤信息)
• 一致性 (接口信息一致，不會出現因開發人員拿到的文檔版本不一致，而出現分歧)
• 可測性 (直接在接口文檔上進行測試，以方便理解業務)

二、springboot 整合 swagger2

1、在pom中添加依賴

		<!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>

		<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>

2、創建Swagger2配置文件

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket webApiConfig() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .build();
    }

    private ApiInfo webApiInfo() {
        return new ApiInfoBuilder()
                .title("網站-揚帆向海的博客文檔")
                .description("本文檔描述了博客中心微服務接口定義")
                .version("1.0")
                .contact(new Contact("揚帆向海", "http://zhangxy.com", "[email protected]"))
                .build();
    }

}

3、重啓服務器查看接口

http://localhost:8101/swagger-ui.html

具體裏面的內容以及接口測試，這裏就不一一展示了。

---

由於水平有限，本博客難免有不足，懇請各位大佬不吝賜教！