swagger

註解

  • @Api:用在類上,說明該類的做用。
  • @ApiOperation:註解來給API增長方法說明。
  • @ApiImplicitParams : 用在方法上包含一組參數說明。
  • @ApiImplicitParam:用來註解來給方法入參增長說明。
  • @ApiResponses:用於表示一組響應
  • @ApiResponse:用在@ApiResponses中,通常用於表達一個錯誤的響應信息
    code:數字,例如400
    message:信息,例如"請求參數沒填好"
    response:拋出異常的類
  • @ApiModel:描述一個Model的信息(通常用在請求參數沒法使用@ApiImplicitParam註解進行描述的時候)
    @ApiModelProperty:描述一個model的屬性

問題:

返回json不能寫註釋,請求是json的話也不行,最後API文檔仍是用markdown來寫了json

相關文章
相關標籤/搜索