SpringDoc 教學-入門
最近在幫 Hana 引擎加入 openAPI3(swagger3)，想說寫個教學文章。 預計會有兩篇文章漸進式的說明如何導入 openAPI3，分別是: 如何導入 openAPI3 如何客製化 swagger 的網頁內容，如標題、和 API 分組。 今天的文章是如何快速導入 openAPI3 ，並且設定各 API 的說明和 request response 設定 example。 正文 主要有三個步驟: 導入 springDoc lib 和顯示網頁 設定 controller、API 說明 設定 request 、 response 參數說明與 example 讓我們一個一個開始吧。 ヽ(✿ﾟ▽ﾟ)ノ 步驟1: 導入 springDoc lib 和顯示網頁 首先所有的 java lib 都是到 maven repository 取得，因此我們只要到 maven repository 尋找 SpringDoc OpenAPI Starter WebMVC UI ，或者按這個網址: https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui 打開網址 -> 選擇版本就可以看到下面的圖片，在紅色框框中依照專案的依賴管理工具，選擇自己需要的格式並且複製下來。 因為 Hana 引擎是使用 gradle ，因此我複製 gradle 下來並添加到自己專案的 build.gradle (如果是 maven 的話就是 pom.xml) 。 添加依賴之後啟動 spring boot，啟動後開瀏覽器到該專案的網址並且在後面加上 /swagger-ui/index.html#/ 就可以看到專案導入 openAPI 了。 步驟2: 設定 controller、API 說明 在上圖我們可以看到 save-data-controller 和 chat-controller 事實上這兩個都是 springDoc 依照 controller class name 的駝峰顯示出來的。 步驟 2-1 修改 contoller 說明 我們接下來要把它改成看得懂的說明。 其實非常簡單，只要在該 controller 前面加上 tag annotations 就好了，如...