創(chuàng)新互聯(lián)www.cdcxhl.cn八線動(dòng)態(tài)BGP香港云服務(wù)器提供商，新人活動(dòng)買多久送多久，劃算不套路！
不懂SpringBoot為什么要使用Swagger？其實(shí)想解決這個(gè)問題也不難，下面讓小編帶著大家一起學(xué)習(xí)怎么去解決，希望大家閱讀完這篇文章后大所收獲。
前言
Spring Boot 框架是目前非常流行的微服務(wù)框架，我們很多情況下使用它來提供 Rest API。而對(duì)于 Rest API 來說很重要的一部分內(nèi)容就是文檔，Swagger 為我們提供了一套通過代碼和注解自動(dòng)生成文檔的方法，這一點(diǎn)對(duì)于保證 API 文檔的及時(shí)性將有很大的幫助。本文將使用 Swagger 2 規(guī)范的 Springfox 實(shí)現(xiàn)來了解如何在 Spring Boot 項(xiàng)目中使用 Swagger，主要包含了如何使用 Swagger 自動(dòng)生成文檔、使用 Swagger 文檔以及 Swagger 相關(guān)的一些高級(jí)配置和注解。
Swagger 簡介
Swagger 是一套基于 OpenAPI 規(guī)范構(gòu)建的開源工具，可以幫助我們設(shè)計(jì)、構(gòu)建、記錄以及使用 Rest API。Swagger 主要包含了以下三個(gè)部分：
Swagger Editor：基于瀏覽器的編輯器，我們可以使用它編寫我們 OpenAPI 規(guī)范。
Swagger UI：它會(huì)將我們編寫的 OpenAPI 規(guī)范呈現(xiàn)為交互式的 API 文檔，后文我將使用瀏覽器來查看并且操作我們的 Rest API。
Swagger Codegen：它可以通過為 OpenAPI（以前稱為 Swagger）規(guī)范定義的任何 API 生成服務(wù)器存根和客戶端 SDK 來簡化構(gòu)建過程。
為什么要使用 Swagger
當(dāng)下很多公司都采取前后端分離的開發(fā)模式，前端和后端的工作由不同的工程師完成。在這種開發(fā)模式下，維持一份及時(shí)更新且完整的 Rest API 文檔將會(huì)極大的提高我們的工作效率。傳統(tǒng)意義上的文檔都是后端開發(fā)人員手動(dòng)編寫的，相信大家也都知道這種方式很難保證文檔的及時(shí)性，這種文檔久而久之也就會(huì)失去其參考意義，反而還會(huì)加大我們的溝通成本。而 Swagger 給我們提供了一個(gè)全新的維護(hù) API 文檔的方式，下面我們就來了解一下它的優(yōu)點(diǎn)：
代碼變，文檔變。只需要少量的注解，Swagger 就可以根據(jù)代碼自動(dòng)生成 API 文檔，很好的保證了文檔的時(shí)效性。
跨語言性，支持 40 多種語言。
Swagger UI 呈現(xiàn)出來的是一份可交互式的 API 文檔，我們可以直接在文檔頁面嘗試 API 的調(diào)用，省去了準(zhǔn)備復(fù)雜的調(diào)用參數(shù)的過程。
還可以將文檔規(guī)范導(dǎo)入相關(guān)的工具（例如 SoapUI）, 這些工具將會(huì)為我們自動(dòng)地創(chuàng)建自動(dòng)化測試。
以上這些優(yōu)點(diǎn)足以說明我們?yōu)槭裁匆褂?Swagger 了，您是否已經(jīng)對(duì) Swagger 產(chǎn)生了濃厚的興趣了呢？下面我們就將一步一步地在 Spring Boot 項(xiàng)目中集成和使用 Swagger，讓我們從準(zhǔn)備一個(gè) Spring Boot 的 Web 項(xiàng)目開始吧。
SpringBoot整合Swagger2
1.首先創(chuàng)建一個(gè)基礎(chǔ)的SpringBoot web項(xiàng)目。您可以通過 Spring Initializr 頁面生成一個(gè)空的 Spring Boot 項(xiàng)目，或者通過idea創(chuàng)建一個(gè)SpringBoot項(xiàng)目
2.添加依賴
Spring Boot 的 Web 依賴
org.springframework.boot spring-boot-starter-web
重慶分公司
重慶分公司
