swagger 註解

  • api接口的定義文檔常使用swagger進行,下面試一些常用註解。
  • @Api 註解類 ,用來描述此類的相關信息
@Api(value = "城市查詢相關接口", description = "城市相關接口")
public interface City{
}
  • @ApiOperation 註解方法 ,聲明此方法的作用
     @ApiOperation(value = "城市查詢接口")

     

  • @ApiModel 註解類,聲明類,比如入參出參對象。
    
  • @ApiModelProperty  聲明類的屬性
  • 效果:
  • 注意:點擊Model纔會看到實體類註解
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章