springboot + swagger的實體類屬性注解


@Api:用在類上,說明該類的作用
@ApiOperation:用在方法上,說明方法的作用
@ApiImplicitParams:用在方法上包含一組參數說明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一個請求參數的各個方面
    paramType:參數放在哪個地方
        header-->請求參數的獲取:@RequestHeader
        query-->請求參數的獲取:@RequestParam
        path(用於restful接口)-->請求參數的獲取:@PathVariable
        body(不常用)
        form(不常用)
    name:參數名
    dataType:參數類型
    required:參數是否必須傳
    value:參數的意思
    defaultValue:參數的默認值
@ApiResponses:用於表示一組響應
@ApiResponse:用在@ApiResponses中,一般用於表達一個錯誤的響應信息
    code:數字,例如400
    message:信息,例如"請求參數沒填好"
    response:拋出異常的類
@ApiModel:描述一個Model的信息(這種一般用在post創建的時候,使用@RequestBody這樣的場景,請求參數無法使用@ApiImplicitParam注解進行描述的時候)
    @ApiModelProperty:描述一個model的屬性

具體其他的注解,查看:

https://github.com/swagger-api/swagger-core/wiki/Annotations#apimodel


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM