修改接口注解用于swagger接口调用

1、为了能够使用Swagger完成登录验证并调用后台接口,所有的接口都添加如下注解:

@ApiOperation("=====接口描述=====")

@ApiImplicitParams({

    @ApiImplicitParam(name = "X-Emp-No", value = "X-Emp-No", dataType = "String", paramType = "header"),

    @ApiImplicitParam(name = "X-Emp-Name", value = "X-Emp-Name", dataType = "String", paramType = "header"),

    @ApiImplicitParam(name = "X-Auth-Value", value = "X-Auth-Value", dataType = "String", paramType = "header")})

2、对于RequestMethodPOST/PUT类型,由于接口入参中已经添加了@RequestBodySwagger界面调用时入参为Json类型数据,添加上述注解即可无需其他操作。

3、对于RequestMethodDELETE/GET类型,如下例需对每个入参添加@RequestParam注解将其Parameter Type设置为query类型。

注意:@RequestParam注解默认该参数为必填项不可以为空,若实际场景可以为空,则添加@RequestParam(required = false)属性即可。

public ServiceData getPage(HttpServletRequest request, @RequestParam(required = false) String engineClusterName, @RequestParam Long currentPage, @RequestParam Long pageSize, @RequestParam String amount)

4、Swagger访问地址(例如runner微服务):

http://localhost:8094/projectName/swagger-ui.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值