Swagger 文件常用註解

2022-09-07 08:24:11 字數 998 閱讀 8148

引用自 

## 常用註解及屬性

@api:用在請求的類上,表示對類的說明

@apioperation:用在請求的方法上,說明方法的用途、作用

@apiparam:單個引數描述

@apimodel:用物件來接收引數

@apimodelproperty:用物件接收引數時,描述物件的乙個字段

@apiignore:使用該註解忽略這個api,用於類或者方法上

@apiimplicitparams:用在請求的方法上,表示一組引數說明

@apiimplicitparam:用在@apiimplicitparams註解中,指定乙個請求引數的各個方面

## 註解及屬性具體表現

@api:用在請求的類上,表示對類的說明

@apioperation:用在請求的方法上,說明方法的用途、作用

@apioperation(value = "用於方法描述",notes = "用於提示內容")

@apiparam:單個引數描述

public string hello(@apiparam(name = "massage",value = "引數說明",required = true)string massage)

swagger文件註解使用

效果圖 controller註解 這裡給引數新增註解,我傾向於使用下面這種 apiimplicitparams public zingresult selectallusers integer page,integer size 而不是這種 public zingresult selectone a...

swagger常用註解

一 swagger常用註解 1 與模型相關的註解 兩個註解 2 與介面相關的註解 六個註解 二 幾個注意點 為了在swagger ui上看到輸出,至少需要兩個註解 api和 apioperation 即使只有乙個 apiresponse,也需要使用 apiresponses包住 對於 apiimpl...

swagger常用註解

一 swagger常用註解 1 與模型相關的註解 兩個註解 2 與介面相關的註解 六個註解 二 幾個注意點 為了在swagger ui上看到輸出,至少需要兩個註解 api和 apioperation 即使只有乙個 apiresponse,也需要使用 apiresponses包住 對於 apiimpl...