Udemy 課程Microservices with Spring 15

Swagger文件

ZONGRU Li
4 min readJun 23, 2019

在pom檔內加入兩個dependency(boot版本2.1.0+以上建議用swagger2.6.1):

接著建立Swagger文件定義檔(java檔)

基本要設定的內容如下注解

在建立以上設定後啟動會見到:

看來是2.2.0.BUILD-SNAPSHOT版本的jar有些問題(畢竟不是穩定版本)

更改版本為

其中之前UserResource內做link的方法要改寫

包含完整import改為

在又搞定兩個jar下載不完全的錯誤

(刪repository路徑套件後重新maven update)

終於可以完整執行並看到

進到 http://localhost:8089/v2/api-docs看見:

密密麻麻的文件內容!!

特別地進到 http://localhost:8089/swagger-ui.html(注意console沒印出來)

展開看更多資訊!!

各個web service定義都變成UI顯示!!

加入JSON viewer到Chrome擴充功能裡,再看一次 http://localhost:8089/v2/api-docs

大略可看到swagger版本等等資訊!
path看到提供的Web Service
users下有GET跟POST
users的GET規格
user的POST規格跟傳入參數
definitions定義我們API傳遞的物件內容
比方說User包含什麼屬性(如上圖)

各種各樣的Web Service資訊都已在這文件內出現!!

因應更改Spring 版本,再保一版為” restful-web-services_5"

--

--

ZONGRU Li
ZONGRU Li

Written by ZONGRU Li

2022/11/17 開源部分個人筆記給LINE "Java程式語言討論區"社群,希望能對社群的技術學習做一點點貢獻.(掩面....記得退訂閱!

No responses yet