API文檔框架Swagger3視頻教程

關注 java資料站 公眾號 回復  swagger   獲取

Swagger（絲襪哥）是一個簡單但功能強大的API表達工具。它具有地球上最大的API工具生態系統，數以千計的開發人員，使用幾乎所有的現代編程語言，都在支持和使用Swagger。使用Swagger生成API，我們可以得到交互式文檔，自動生成代碼的SDK以及API的發現特性等。

前后端分離的項目，接口文檔的存在十分重要。與手動編寫接口文檔不同，swagger是一個自動生成接口文檔的工具，在需求不斷變更的環境下，手動編寫文檔的效率實在太低。與swagger2相比新版的swagger3配置更少，使用更加方便。

官網 https://swagger.io/

在線編輯器 http://editor.swagger.io/

Swagger作用：

• 將項目中所有的接口展現在頁面上，這樣后端程序員就不需要專門為前端使用者編寫專門的接口文檔；

• 當接口更新之后，只需要修改代碼中的 Swagger 描述就可以實時生成新的接口文檔了，從而規避了接口文檔老舊不能使用的問題；

• 通過 Swagger 頁面，我們可以直接進行接口調用，降低了項目開發階段的調試成本。

現在SWAGGER官網主要提供了幾種開源工具，提供相應的功能?？梢酝ㄟ^配置甚至是修改源碼以達到你想要的效果

Swagger Codegen: 通過Codegen 可以將描述文件生成html格式和cwiki形式的接口文檔，同時也能生成多鐘語言的服務端和客戶端的代碼。支持通過jar包，docker，node等方式在本地化執行生成。也可以在后面的Swagger Editor中在線生成。

Swagger UI:提供了一個可視化的UI頁面展示描述文件。接口的調用方、測試、項目經理等都可以在該頁面中對相關接口進行查閱和做一些簡單的接口請求。該項目支持在線導入描述文件和本地部署UI項目。

Swagger Editor: 類似于markendown編輯器的編輯Swagger描述文件的編輯器，該編輯支持實時預覽描述文件的更新效果。也提供了在線編輯器和本地部署編輯器兩種方式。

Swagger Inspector: 感覺和postman差不多，是一個可以對接口進行測試的在線版的postman。比在Swagger UI里面做接口請求，會返回更多的信息，也會保存你請求的實際請求參數等數據。

Swagger Hub：集成了上面所有項目的各個功能，你可以以項目和版本為單位，將你的描述文件上傳到Swagger Hub中。在Swagger Hub中可以完成上面項目的所有工作，需要注冊賬號，分免費版和收費版。