1. 程式人生 > >Swagger自動生成OpenApi文件

Swagger自動生成OpenApi文件

一、文件編寫

1.UI介面 前往swaggerHub官網進行編寫,註冊即可

2.選擇自己的專案 例如:itsm-open_api

3.支援json和yaml格式進行書寫介面,推薦yaml格式,非常的方便,誰用誰知道

4.編寫無錯誤之後右上角下載按鈕下載為yaml格式檔案

5.為了防止html會有中文亂碼、格式錯亂等問題,故將匯出的yaml檔案放進swagger工程中,用idea打包後取html資料夾中的html檔案。

注意事項:

即使從idea打完包取出來的html也是存在部分亂碼情況,因為windows預設編碼GBK,生成的html的編碼格式為utf-8,因此會產生亂碼問題。使用linux或者用IDE強制專案使用utf8編碼即可。


Windows環境下需要修改環境變數,讓JVM使用utf8編碼。新增環境變數 JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF8。修改成功後再次執行mvn package會看到控制檯會額外列印一行資訊: Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF8 生成的html就不會亂碼了。