swagger註解的使用

前面有介紹過swagger的專案整合步驟，但是沒有確切的註解使用內容。

下面我就對swagger使用註解進行一些比較細化的記錄，如果漏了啥，可以在提醒我。下面直接進入主題。

@api

說明：用於controller層類註解，引數有value和tags。都是說明的意思。（註解寫在類上）

@apioperation(value = "新增")

說明：用於controller層方法註解，value用於方法描述，notes用於提示內容，tags可以分組說明。都是說明的意思。（註解寫在方法上）

@apiparam()

說明：用於controller層方法引數註解，name-引數名，value用於引數說明，required引數是否必填。（註解寫在方法上）

@apimodel

說明：用於實體類vo註解，value用於類說明，直接填寫類名，description用於表示model描述說明。（註解寫在類上）

@apimodelproperty

說明：用於實體類vo引數註解，value用於引數字段說明，name填寫屬性名字一般直接寫變數名，datatype用於填寫引數型別，required是否必須填寫，example舉例一般不用，hidden在swagger中隱藏。（註解寫在引數上）

@apiignore()

說明：用於類或者方法上，在swagger中隱藏。（註解寫在類或者方法上）

@apiimplicitparam()

說明：用於controller層類註解方法引數註解。name-引數名，value用於引數說明，datatype用於填寫引數型別，required是否必須填寫，example舉例一般不用。改註解和@apiparam類似所以可以二選一使用（註解寫在方法的括號裡）

@apiimplicitparams()

說明：用於controller層類註解方法引數註解，其實就是多個@apiimplicitparam()（註解寫在方法的括號裡）

2、總結

其實對於swagger還是比較簡單的，以上就是我常用的註解，不過應該每個註解還有很多其他的引數，這上面只是我用的時候經常用到的一些。