Swagger 2（Open API v3.0） Java 文件生成指南（下）

摘要： 先介紹網上“搜刮”的資源： Swagger從入門到精通，如何編寫基於 OpenAPI 規範的 API 文件，https://legacy.gitbook.com/book/huangwenchao/swagger/details https://blog...

先介紹網上“搜刮”的資源：

• Swagger從入門到精通，如何編寫基於 OpenAPI 規範的 API 文件，ofollow,noindex" target="_blank">https://legacy.gitbook.com/book/huangwenchao/swagger/details https://blog.csdn.net/lucky373125/article/details/80471525
• Swagger和OpenAPIhttps://www.breakyizhan.com/swagger/2806.html
• Swagger 2與OpenAPI 3https://www.jianshu.com/p/879baf1cff07

和Swagger UI的整合

怎麼把這些 API 資訊漂亮地展示出來呢？ 接下來我們通過整合 Swagger UI 來實現。首先是下載Swargger UI，它是一個 react 寫成的純前端專案，可以整合到任意服務端中，只要讓可以讀取到 API 的定義檔案即可，所以呢，哪怕是 file:// 開啟也行，它會解析可以訪問到的 yaml/json 檔案，渲染漂亮的文件出來。

Swagger UI 不過就是 HTML+JS+CSS，到https://github.com/swagger-api/swagger-ui/tree/master/dist 下載，注意是 dist 釋出版本。如果你前端動手能力強，可以使用非 dist 版的，通過 webpack 等其他方案整合。但那樣就不是和 Java Web 專案集成了，另外一個 web service 服務在跑。我為了省事，整合在當前 java 專案中，用 tomcat 跑。

但也要注意一下訪問許可權的問題，不能讓所有人都訪問，特別是包含敏感資訊的介面。

下載回來，解壓，發現原始碼包含 map 用於除錯的，好幾兆呢，我們不要，只要 HTML/JS/CSS 便可。

執行一下，沒毛病呢。