swagger使用map传参和实体传参编写注释

@AutoLog(value = "web首页-地图显示按行政区划")
@ApiOperation(value="web首页-地图显示按行政区划")
@ApiImplicitParams({@ApiImplicitParam(paramType = "query",name = "orgType",value ="行政等级",dataType ="String"),
                    @ApiImplicitParam(paramType = "header",name = "X-Access-Token",value ="token标记",dataType ="String"),
                    @ApiImplicitParam(paramType = "query",name = "firstFacilitiesId",value ="一级设施id",dataType ="String"),
                    @ApiImplicitParam(paramType = "query",name = "id",value ="区域id",dataType ="String"),
                    @ApiImplicitParam(paramType = "query",name = "leftLongitude",value ="地图左下经度",dataType ="decimal"),
                    @ApiImplicitParam(paramType = "query",name = "leftLatitude",value ="地图左下纬度",dataType ="decimal"),
                    @ApiImplicitParam(paramType = "query",name = "rightLongitude",value ="地图右上经度",dataType ="decimal"),
                    @ApiImplicitParam(paramType = "query",name = "rightLatitude",value ="地图右上纬度",dataType ="decimal")
         }
)
@GetMapping(value = "/circleCountByOrgType")
public Result<?> circleCountByOrgType(
        @ApiIgnore @RequestParam(required = false) Map param) {
    return Result.ok(mapList);
}

一:当所传参数为map时如何添加参数说明

  1：需要不显示param为参数时可以使用@ApiIgnore注解，如图效果
      

2：需要对map中的参数进行说明使用@ApiImplicitParams和@ApiImplicitParam两个注解，@ApiImplicitParams结合@ApiImplicitParam使用也可以单独使用@ApiImplicitParam注解。
3：@ApiImplicitParam参数说明：

   一：paramType = "query" 参数类型，值可以为:query，header。
   二：name = "id" 参数名。
   三：value ="区域id" 参数说明。
   四：dataType ="String" 数据类型。

 

 

@AutoLog(value = "PC关联字典-编辑")
@ApiOperation(value="PC关联字典-编辑", notes="PC关联字典-编辑")
@PutMapping(value = "/edit")
public Result<?> edit(@RequestBody BFacilitiesFiledPc bFacilitiesFiledPc) {
   bFacilitiesFiledPcService.updateById(bFacilitiesFiledPc);
   return Result.ok("编辑成功!");
}

二：当为实体接收时

1:@ApiModel 注解在实类上。
2:@ApiModelProperty 注解在实体类上的方法字段上。

查看实体需传入参数(example value):

查看需传入参数的属性释义(切换为model):