@configuration
public class swagger2
private apiinfo apiinfo()
}
public static void main(string args)
}
io.springfox
springfox-swagger2
2.9.2
io.springfox
springfox-swagger-ui
2.9.2
@data
@equalsandhashcode(callsuper = true)
@accessors(chain = true)
@tablename("t_uls_daily_price")
@apimodel(value="dailyprice物件", description="每日實時統計**")
public class dailyprice extends model
}頁面顯示如下
位址http://localhost:8080/swagger-ui.html樣式如下
@api：用在請求的類上，表示對類的說明
tags="說明該類的作用，可以在ui介面上看到的註解"
value="該引數沒什麼意義，在ui介面上也看到，所以不需要配置"
@apioperation：用在請求的方法上，說明方法的用途、作用
value="說明方法的用途、作用"
notes="方法的備註說明"
@apiimplicitparams：用在請求的方法上，表示一組引數說明
@apiimplicitparam：用在@apiimplicitparams註解中，指定乙個請求引數的各個方面
name：引數名
value：引數的漢字說明、解釋
required：引數是否必須傳
paramtype：引數放在哪個地方
· header --> 請求引數的獲取：
@apiresponses：用在請求的方法上，表示一組響應
@apiresponse：用在@apiresponses中，一般用於表達乙個錯誤的響應資訊
code：數字，例如400message：資訊，例如"請求引數沒填好"response：丟擲異常的類
@apimodel：用於響應類上，表示乙個返回響應資料的資訊
（這種一般用在post建立的時候，使用@requestbody這樣的場景，
請求引數無法使用@apiimplicitparam註解進行描述的時候）
@apimodelproperty：用在屬性上，描述響應類的屬性
@api：修飾整個類，描述controller的作用
@apioperation：描述乙個類的乙個方法，或者說乙個介面
@apiparam：單個引數描述
@apimodel：用物件來接收引數
@apiproperty：用物件接收引數時，描述物件的乙個字段
@apiresponse：http響應其中1個描述
@apiresponses：http響應整體描述
@apiignore：使用該註解忽略這個api
@apierror ：發生錯誤返回的資訊
@apiimplicitparam：乙個請求引數
@apiimplicitparams：多個請求引數
swagger2的簡單使用
優點 可以生成文件形式的api並提供給不同的團隊使用 便於自己單測 無需過多冗餘的word文件，這一點很重要，因為我在工作中就遇到這麼乙個情況，由於開發使用的文件和最新文件版本導致不一致，導致後期很煩人 使用swagger流程 1.引入pom依賴 io.springfox springfox swa...
swagger2 常用註解的使用
一 api 效果 api註解放在類上面，這裡的value是沒用的，tags表示該controller的介紹。二 apioperation 效果 apioperation註解用於放在方法上面，其中value是該類的簡短的敘述，notes一般是該方法的詳細描述。三 apiimplicitparam 與 ...
springboot搭建swagger2超簡單
必須使用以下配置開啟swagger服務 enableswagger2 configuration enableswagger2 public class swaggerconfig implements webmvcconfigurer private apiinfo apiinfo api tag...