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

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

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

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

前言

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

Swagger 簡(jiǎn)介

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

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

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

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

為什么要使用 Swagger

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

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

跨語(yǔ)言性，支持 40 多種語(yǔ)言。

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

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

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

SpringBoot整合Swagger2

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

2.添加依賴(lài)

Spring Boot 的 Web 依賴(lài)　

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

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

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

廣告

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