Swagger2相關(guān)注解

針對類相關(guān)注解:@API,tags和value。其中tags與value都表示說明,一般使用tags進(jìn)行替代,會自動覆蓋value的說明。
針對方法的注解:@ApiOperation。用于方法,常用value與tags。value用于方法描述,notes用于提示具體內(nèi)容。如果一致可不寫。
針對參數(shù)的部分注解:@ApiParam()用于方法,做部分的參數(shù),字段說明。name:參數(shù)名。value:參數(shù)說明。如果name和傳遞的參數(shù)一致可省略。
針對實(shí)體類: @APIModel()用于實(shí)體類,參數(shù)是value和description.當(dāng)前類對象及對應(yīng)描述,都可省略。
針對實(shí)體類的屬性:@ApiModelProperty,常用的是name.value及example,其中name可省略,主要是用來重寫屬性類型的。如何屬性名一致可不寫。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容