swagger接口怎麼寫

兩大步:

一標識model類:

1、modle類名上要加:@ApiModel(value=“地址”,description=“地址” ) 說明該類是swagger 標識

2、modle屬性上加 : @ApiModelProperty(value = “會員id”,required=false,example=“321”) swagger 屬性 介紹

   這裏的example 很必要 、會再swagger 頁面上 對應生成測試參數、方便前端或者測試進行測試接口

在這裏插入圖片描述這裏就可以很方便的進行前端展示傳入參數 進行測試
包括 可以再測試insert 插入數據庫的時候,也可以進行方便生成測試數據,只要雙擊下參數 model 就可以賦值
在這裏插入圖片描述

兩種情況下 沒顯示該對象 列表值

1、 我在該對象上定義了@RequestBody  product    又在方法上面定了了    @ApiImplicitParam(name = "product")
      swagger 上沒顯示出來  應該去掉方法上的@ApiImplicitParam(name = "product")    不能重複
      
 2、我忘記在model 類 添加 get 和set 方法  。所以導致沒顯示。
 3、在model 類上  定了同名的@ApiModel(value="商品")  導致 在swagger 的model類展示上一直被另一個model類覆蓋

二是標識:接口類

1、類名上加: @Api(tags = “PcProductResource”, description = “PC端—產品服務資源”)
2、查詢方法加:

@ApiOperation("-PC端-查詢商品")      
@ApiImplicitParams({
        @ApiImplicitParam(name = "pageNum", value = "頁碼", required = true, paramType = "", dataType = ""),
        @ApiImplicitParam(name = "pageSize", value = "每頁多少", required = true, paramType = "", dataType = "")

})
@RequestMapping(value = "/queryProduct", method = RequestMethod.POST)
@ResponseBody
    public PaginationInfoResDTO queryProduct( Integer pageNum, Integer pageSize, boolean cache, @RequestBody ProductRequestDTO productRequestDTO){

1、標識該方法爲 PC端-查詢商品

@ApiOperation("-PC端-查詢商品")  

2、這裏指的是標識多個參數

@ApiImplicitParams ({
           @ApiImplicitParam(),
           @ApiImplicitParam()
})

3、這裏指的是 這裏指的訪問路徑

@RequestMapping(value = "/queryProduct", method = RequestMethod.POST)
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章