本文給大家介紹的內(nèi)容是系統(tǒng)集成服務(wù)集成交互技術(shù)：REST服務(wù)集成，Swagger接口文檔規(guī)范；

Swagger接口文檔規(guī)范

上一節(jié)中我們使用REST標(biāo)準(zhǔn)描述了一個使用訂單服務(wù)的API文檔。

然而API文檔的維護(hù)，給技術(shù)人員帶來了額外的工作量。另外，技術(shù)文檔人員對API的理解的偏差，也給API文檔的可操作性帶來了問題。對于后端人員，Swagger為我們提供了一個在線的REST API文檔，可以提供給不同團(tuán)隊(duì)，加速開發(fā)過程，也提供了更加便攜的基于標(biāo)準(zhǔn)文檔的交互方式。

Swagger API標(biāo)準(zhǔn)

Swagger是一個規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化RESTful風(fēng)格的Web服務(wù)。Swagger的目標(biāo)是定義標(biāo)準(zhǔn)的、和語言無關(guān)的接口，讓人和計算機(jī)無須訪問源碼、文檔或進(jìn)行網(wǎng)絡(luò)流量監(jiān)測就可以發(fā)現(xiàn)和理解服務(wù)的能力。

Swagger規(guī)范定義了一組描述一個API所需的文件格式，類似于描述Web服務(wù)的WSDL。通過Swagger進(jìn)行REST API的正確定義，用戶可以理解遠(yuǎn)程服務(wù)并使用最少實(shí)現(xiàn)邏輯與遠(yuǎn)程服務(wù)進(jìn)行交互。與底層編程所實(shí)現(xiàn)的接口類似，Swagger消除了調(diào)用服務(wù)時產(chǎn)生的理解差異。

集成Swagger的步驟

1.導(dǎo)入Maven依賴

2.實(shí)現(xiàn)Swagger配置類

注解說明：

● @EnableSwagger2：Swagger2啟動注解。

● @Configuration：聲明這是一個配置類。

3.配置接口的API參數(shù)描述

網(wǎng)關(guān)集成Swagger

Swagger是一個API文檔生成工具，在微服務(wù)架構(gòu)中，API網(wǎng)關(guān)可以起到聚合后端眾多微服務(wù)的作用，同時可以利用微服務(wù)網(wǎng)關(guān)集成Swagger生成所有微服務(wù)的接口文檔。下面是基于網(wǎng)關(guān)Zuul集成Swagger的文檔示例。

本文給大家講解的內(nèi)容是系統(tǒng)集成服務(wù)集成交互技術(shù)：REST服務(wù)集成，Swagger接口文檔規(guī)范

1. 下篇文章給大家講解的內(nèi)容是系統(tǒng)集成服務(wù)集成交互技術(shù)：REST服務(wù)集成，JAX-RS提供REST服務(wù)

2. 覺得文章不錯的朋友可以轉(zhuǎn)發(fā)此文關(guān)注小編；

3. 感謝大家的支持！

5. 本文就是愿天堂沒有BUG給大家分享的內(nèi)容，大家有收獲的話可以分享下，想學(xué)習(xí)更多的話可以到微信公眾號里找我，我等你哦。