Swagger2 整合Springboot（二） 注解讲解

一、注解列举与详解

@Api：修饰整个类，描述Controller的作用

@Api(description = "物流接口")

@ApiOperation : 用在方法上，说明方法的作用

1.     value: 表示接口名称
2.     notes: 表示接口详细描述 

    @ApiOperation(value = "物流接口非第三方接口",notes = "物流接口非第三方接口",httpMethod = "GET")

 

@ApiImplicitParam：用在方法上包含一组参数说明

     1.paramType：参数位置

        1.1  header 对应注解：@RequestHeader

        1.2  query 对应注解：@RequestParam

        1.3  path  对应注解: @PathVariable

        1.4  body 对应注解: @RequestBody

     2.name：参数名

     3.dataType：参数类型

     4.required：参数是否必须传

     5.value：参数的描述

     6.defaultValue：参数的默认值

 @ApiImplicitParam(name = "orderId",value = "订单id",required = true, dataType = "int" ,paramType = "query")

@ApiImplicitParams：用在方法上包含一组参数说明

@ApiIgnore: 表示该接口函数不对swagger2开放展示

@ApiModel：用对象来接收参数 

@ApiModel(value = "物流接口实体类")

@ApiModelProperty用对象接收参数时，描述对象的一个字段 

@ApiModelProperty( value = "详细物流信息",example = "12313")

@ApiResponse：HTTP响应其中一个描述

@ApiResponses：HTTP响应一组描述

    @ApiResponses({@ApiResponse(code = 200,message = "success",response = ShopCodeDTO.class)})

@ApiParam  描述参数信息(自动识别放在参数后面的paramType与dataType

@ApiParam(name="orderId",value = "订单id",required = true)

二、全部代码如下

@Api(description = "物流接口")
@RestController
@RequestMapping("/admin/vi/logistics")
public class LogisticsController {


    @Resource
    OrderInfoMapper orderInfoMapper;


    /**
     * 查询物流非第三方接口信息
     * @param orderId
     * @return
     */
    @ApiOperation(value = "物流接口非第三方接口",notes = "物流接口非第三方接口",httpMethod = "GET")
    @ApiResponses({@ApiResponse(code = 200,message = "success",response = ShopCodeDTO.class)})
    @GetMapping("/getMessage")
    public JsonResponse getCode(
            @ApiParam(name="orderId",value = "订单id",required = true)
            @RequestParam("orderId") Integer orderId,
            @ApiParam(name="shopCodeDTO",value = "物流实体类",required = true)
            @RequestBody ShopCodeDTO shopCodeDTOs
    ) {
        OrderInfo orderInfo = orderInfoMapper.selectByPrimaryKey(orderId);
        ShopCodeDTO shopCodeDTO = new ShopCodeDTO();
        //物流公司
        shopCodeDTO.setLogisticsCompany(orderInfo.getShippingName() == null ? "" : orderInfo.getShippingName());
        //物流编号
        shopCodeDTO.setLogisticsNumber(orderInfo.getShippingCode() == null ? "" : orderInfo.getShippingCode());
        // 运费
        shopCodeDTO.setLogisticsMoney(orderInfo.getShippingMoney() == null ? 0d : orderInfo.getShippingMoney());
        return JsonResponse.successResponseWithData(shopCodeDTO);
    }

}