swagger2 注解說明文檔


@Api:用於類上,說明該類的作用。可以標記一個Controller類做為swagger 文檔資源
@Api(value = "xxx", description = "xxx")
     value    url的路徑值
     tags    如果設置這個值、value的值會被覆蓋
     description    對api資源的描述
     basePath    基本路徑可以不配置
     position    如果配置多個Api 想改變顯示的順序位置
     produces    For example, "application/json, application/xml"
     consumes    For example, "application/json, application/xml"
     protocols    Possible values: http, https, ws, wss.
     authorizations    高級特性認證時配置
     hidden    配置為true 將在文檔中隱藏

@ApiOperation:用於方法上,說明方法的作用,每一個url資源的定義 @ApiOperation(value
= "xxx",httpMethod="POST", notes= "xxx",response=String.class) value url的路徑值 tags 如果設置這個值、value的值會被覆蓋 notes 對api資源的描述 position 如果配置多個Api 想改變顯示的順序位置 produces For example, "application/json, application/xml" consumes For example, "application/json, application/xml" protocols Possible values: http, https, ws, wss. authorizations 高級特性認證時配置 hidden 配置為true 將在文檔中隱藏 response 返回的對象 responseContainer 這些對象是有效的 "List", "Set" or "Map".,其他無效 httpMethod "GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH" code http的狀態碼 默認 200 extensions 擴展屬性

@ApiParam:用於方法、參數、字段上,請求屬性
public ResponseEntity<User> createUser(@RequestBody @ApiParam(value = "Created user object", required = true) User user) name 屬性名稱 value 屬性值 defaultValue 默認屬性值 allowableValues 可以不配置 required 是否屬性必填 access allowMultiple 默認為false hidden 隱藏該屬性 example 示例

@ApiResponse:用於方法上,響應配置 @ApiResponse(code
= 400, message = "Invalid user supplied") code http的狀態碼 message 描述 response 默認響應類 Void reference 參考ApiOperation中配置 responseHeaders 參考 ResponseHeader 屬性配置說明 responseContainer 參考ApiOperation中配置

@ApiResponses:用於方法上,響應集配置 @ApiResponses({ @ApiResponse(code
= 400, message = "Invalid Order") }) value 多個ApiResponse配置

@ResponseHeader :用於方法上,響應頭設置 @ResponseHeader(name
="head1",description="response head conf") name 響應頭名稱 description 頭描述 response 默認響應類 Void responseContainer 參考ApiOperation中配置

@ApiImplicitParams 用於方法上,包含一組參數說明

@ApiImplicitParam 用於方法上,用在@ApiImplicitParams注解中,指定一個請求參數的各個方面 paramType 參數放在哪個地方 name 參數代表的含義 value 參數名稱 dataType 參數類型,有String
/int,無用 required 是否必要 defaultValue 參數的默認值

@ApiModel 用於類上,描述一個Model的信息(這種一般用在post創建的時候,使用@RequestBody這樣的場景,請求參數無法使用@ApiImplicitParam注解進行描述的時候

@ApiModelProperty 用於方法、字段上,描述一個model的屬性

@ApiIgnore 用於類,屬性,方法上,忽略某項api,使用@ApiIgnore

 


免責聲明!

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



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