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、对于RequestMethod为POST/PUT类型,由于接口入参中已经添加了@RequestBody,Swagger界面调用时入参为Json类型数据,添加上述注解即可无需其他操作。
3、对于RequestMethod为DELETE/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