swagger常用注解

swagger常用注解总结（项目中的实际应用）

实体类

@Api(tags = "订单")+++类
@ApiModelProperty(value="备用金唯一id")+++属性

控制器

@Api(tags = "订单")+++类
@ApiOperation(value = "查询订单列表", httpMethod = "POST")+++方法
@ApiImplicitParams({@ApiImplicitParam(name = "id", value = "订单id", required = true),
        @ApiImplicitParam(name = "company_id", value = "公司id", required = true),})
public ResultData<OrderDetailVO> querydetail(@RequestParam(value = "id") String id,
                                             @RequestParam(value = "company_id") String company_id)
                                             或者
                                             (@ApiParam(name = "id", value = "产品唯一id", required = true) String id,
                  @ApiParam(name = "top", value = "1表示置顶2表示取消置顶", required = true) Integer top)

@ApiParam和@ApiImplicitParam的去区别

@ApiParam和@ApiImplicitParam的功能是相同的，但是@ApiImplicitParam的适用范围更广。在非JAX-RS的场合（比如使用servlet提供HTTP接口），只能使用@ApiImplicitParam进行参数说明。我认为，这是因为接口并不显式展示入参的名称，所以没有地方去使用@ApiParam，只能在接口的方法声明下方写@ApiImplicitParam