swagger常用註解說明

2022-04-06 12:24:14 字數 851 閱讀 6393

用在類上,說明該類的作用。

@api(tags = "bsfieldcontroller",description = "field相關介面")

用在方法上,說明方法的作用

@apioperation(value = "bsfield條件分頁查詢",notes = "分頁條件查詢bsfield方法詳情",tags = )

用在方法上包含一組引數說明

表示單獨的請求引數

@apioperation(value = "bsfield條件分頁查詢",notes = "分頁條件查詢bsfield方法詳情",tags = )

@apiimplicitparams()

public result> findpage(@requestbody(required = false) @apiparam(name = "bsfield物件",value = "傳入json資料",required = false) bsfield bsfield, @pathvariable int page, @pathvariable int size)

用於方法,引數,字段說明

/***

* 根據id查詢bsfield資料

* @param id

* @return

*/@apioperation(value = "bsfield根據id查詢",notes = "根據id查詢bsfield方法詳情",tags = )

public resultfindbyid(@pathvariable @apiparam(value = "主鍵id", required = true) integer id)

swagger註解說明 swagger常用註解說明

常用到的註解有 apiapimodel apimodelproperty apioperation apiparam apiresponse apiresponses responseheader 1.api標記 api 用在類上,說明該類的作用。可以標記乙個controller類做為swagger...

swagger常用註解說明

作者 xiangdong she 作者連線 常用到的註解有 api標記 api 標記可以標記乙個controller類做為swagger 文件資源,使用方式 api value user description operations about user 與controller註解並列使用。屬性配置...

swagger常用註解說明

常用到的註解有 1.api標記 api 用在類上,說明該類的作用。可以標記乙個controller類做為swagger 文件資源,使用方式 api value user description operations about user 與controller註解並列使用。屬性配置 屬性名稱 備註v...