1. 程式人生 > >Spring Swagger URL傳參問題(轉)

Spring Swagger URL傳參問題(轉)

官方文檔 require rac 必須 master 傳參 都沒有 github ecif

代碼例子:

    @ApiOperation(value="獲取用戶詳細信息", notes="根據url的id來獲取用戶詳細信息")
    @ApiImplicitParam(paramType="path", name = "id", value = "用戶ID", required = true, dataType = "Long")
    @RequestMapping(value="/{id}", method=RequestMethod.GET)
    public User getUser(@PathVariable Long id) {
        return users.get(id);
    }

網上好多例子都沒有paramType這個參數,導致獲取不到URL的參數,特意記錄一下

詳細的註解說明

  • @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的屬性

感謝 趙計剛 大大的博文分享,終於解決這問題

參考鏈接:http://www.cnblogs.com/java-zhao/p/5348113.html

官方文檔解說:https://github.com/OAI/OpenAPI-Specification/blob/master/versions/1.2.md#524-parameter-object

轉載地址:https://my.oschina.net/lyaohe/blog/1503254

Spring Swagger URL傳參問題(轉)