天天看點

swagger使用過程中的注解

swagger使用過程中的注解

swagger通過注解表明該接口會生成文檔,包括接口名、請求方法、參數、傳回資訊的等等。

  • @Api:修飾整個類,描述Controller的作用
  • @ApiOperation:描述一個類的一個方法,或者說一個接口
  • @ApiParam:單個參數描述
  • @ApiModel:用對象來接收參數
  • @ApiProperty:用對象接收參數時,描述對象的一個字段
  • @ApiResponse:HTTP響應其中1個描述
  • @ApiResponses:HTTP響應整體描述
  • @ApiIgnore:使用該注解忽略這個API
  • @ApiError :發生錯誤傳回的資訊
  • @ApiImplicitParam:一個請求參數
  • @ApiImplicitParams:多個請求參數