swagger接口怎么写

两大步:

一标识model类:

1、modle类名上要加:@ApiModel(value=“地址”,description=“地址” ) 说明该类是swagger 标识

2、modle属性上加 : @ApiModelProperty(value = “会员id”,required=false,example=“321”) swagger 属性 介绍

   这里的example 很必要 、会再swagger 页面上 对应生成测试参数、方便前端或者测试进行测试接口

swagger接口怎么写_第1张图片这里就可以很方便的进行前端展示传入参数 进行测试
包括 可以再测试insert 插入数据库的时候,也可以进行方便生成测试数据,只要双击下参数 model 就可以赋值
swagger接口怎么写_第2张图片

两种情况下 没显示该对象 列表值

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)

你可能感兴趣的:(spring-boot)