SpringBoot為什么要使用Swagger-創(chuàng)新互聯(lián)

創(chuàng)新互聯(lián)www.cdcxhl.cn八線動態(tài)BGP香港云服務(wù)器提供商，新人活動買多久送多久，劃算不套路！

創(chuàng)新互聯(lián)堅持“要么做到，要么別承諾”的工作理念，服務(wù)領(lǐng)域包括：成都網(wǎng)站建設(shè)、網(wǎng)站制作、企業(yè)官網(wǎng)、英文網(wǎng)站、手機端網(wǎng)站、網(wǎng)站推廣等服務(wù)，滿足客戶于互聯(lián)網(wǎng)時代的滴道網(wǎng)站設(shè)計、移動媒體設(shè)計的需求，幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡(luò)建設(shè)合作伙伴！

不懂SpringBoot為什么要使用Swagger？其實想解決這個問題也不難，下面讓小編帶著大家一起學習怎么去解決，希望大家閱讀完這篇文章后大所收獲。

前言

　　Spring Boot 框架是目前非常流行的微服務(wù)框架，我們很多情況下使用它來提供 Rest API。而對于 Rest API 來說很重要的一部分內(nèi)容就是文檔，Swagger 為我們提供了一套通過代碼和注解自動生成文檔的方法，這一點對于保證 API 文檔的及時性將有很大的幫助。本文將使用 Swagger 2 規(guī)范的 Springfox 實現(xiàn)來了解如何在 Spring Boot 項目中使用 Swagger，主要包含了如何使用 Swagger 自動生成文檔、使用 Swagger 文檔以及 Swagger 相關(guān)的一些高級配置和注解。

Swagger 簡介

Swagger 是一套基于 OpenAPI 規(guī)范構(gòu)建的開源工具，可以幫助我們設(shè)計、構(gòu)建、記錄以及使用 Rest API。Swagger 主要包含了以下三個部分：

Swagger Editor：基于瀏覽器的編輯器，我們可以使用它編寫我們 OpenAPI 規(guī)范。

Swagger UI：它會將我們編寫的 OpenAPI 規(guī)范呈現(xiàn)為交互式的 API 文檔，后文我將使用瀏覽器來查看并且操作我們的 Rest API。

Swagger Codegen：它可以通過為 OpenAPI（以前稱為 Swagger）規(guī)范定義的任何 API 生成服務(wù)器存根和客戶端 SDK 來簡化構(gòu)建過程。

為什么要使用 Swagger

當下很多公司都采取前后端分離的開發(fā)模式，前端和后端的工作由不同的工程師完成。在這種開發(fā)模式下，維持一份及時更新且完整的 Rest API 文檔將會極大的提高我們的工作效率。傳統(tǒng)意義上的文檔都是后端開發(fā)人員手動編寫的，相信大家也都知道這種方式很難保證文檔的及時性，這種文檔久而久之也就會失去其參考意義，反而還會加大我們的溝通成本。而 Swagger 給我們提供了一個全新的維護 API 文檔的方式，下面我們就來了解一下它的優(yōu)點：

代碼變，文檔變。只需要少量的注解，Swagger 就可以根據(jù)代碼自動生成 API 文檔，很好的保證了文檔的時效性。

跨語言性，支持 40 多種語言。

Swagger UI 呈現(xiàn)出來的是一份可交互式的 API 文檔，我們可以直接在文檔頁面嘗試 API 的調(diào)用，省去了準備復(fù)雜的調(diào)用參數(shù)的過程。

還可以將文檔規(guī)范導入相關(guān)的工具（例如 SoapUI）, 這些工具將會為我們自動地創(chuàng)建自動化測試。

以上這些優(yōu)點足以說明我們?yōu)槭裁匆褂?Swagger 了，您是否已經(jīng)對 Swagger 產(chǎn)生了濃厚的興趣了呢？下面我們就將一步一步地在 Spring Boot 項目中集成和使用 Swagger，讓我們從準備一個 Spring Boot 的 Web 項目開始吧。

SpringBoot整合Swagger2

1.首先創(chuàng)建一個基礎(chǔ)的SpringBoot web項目。您可以通過 Spring Initializr 頁面生成一個空的 Spring Boot 項目，或者通過idea創(chuàng)建一個SpringBoot項目

2.添加依賴

Spring Boot 的 Web 依賴　

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

標題名稱：SpringBoot為什么要使用Swagger-創(chuàng)新互聯(lián)
文章源于：http://muchs.cn/article0/csppoo.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供網(wǎng)站制作、網(wǎng)站設(shè)計、網(wǎng)站內(nèi)鏈、云服務(wù)器、搜索引擎優(yōu)化、微信公眾號

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時需注明來源： 創(chuàng)新互聯(lián)