【Spring Boot】第23課-利用 Swagger 產生 API 文件

當系統開發出許多 Web API,想要開放給其他人串接時,我們可能會整理出文件,列出 API 的規格及使用說明。然而維護這種文件也是一種成本,若沒有持續地更新,就會發生遺漏或不準確的情形。

本文會引進叫做「Swagger」的工具,它能夠偵測程式專案中定義的 RESTful API,自動產生美觀的 API 文件。這份文件會在網頁上供人觀看,甚至能直接在上面實際呼叫,十分便利。


本文已經搬家,且優化了內容,歡迎到「【Spring Boot】第13課-使用 Swagger UI 製作 API 文件與呼叫介面」繼續閱讀。

留言

  1. 謝謝作者所提供的內容
    跟著做完整個系列真的受益良多 謝謝

    回覆刪除
  2. 想問一下,我照著前兩步做後,頁面上跑出一堆我根本沒有做出來的api,是為什麼呢

    回覆刪除
    回覆
    1. 範例專案會包含前面文章中所實作的 API,並且就這麼累積到本文第 23 課
      你在 Swagger 文件中看到的 API 應該是來自專案中「現有」的 controller 喔!

      刪除

張貼留言