Swagger 给接口、方法体、方法体参数添加描述

1 给接口添加描述

@Api注解可以用来标记当前Controller的功能。

@RestController
@Api(tags = "测试接口")
public class TestController {
}

2 给方法体添加描述

@ApiOperation注解用来标记一个方法的作用。

    @ApiOperation("根据用户编号获取账号信息")
    @GetMapping("/getAccountInfo")
    public AjaxResult getAccountInfo(@RequestParam("userId")String userId) {
        return userService.getAccountInfo(userId);
    }

3 方法体参数添加描述

@ApiImplicitParam注解用来描述一个参数，可以配置参数的中文含义，也可以给参数设置默认值，这样在接口测试的时候可以避免手动输入。

如果有多个参数，则需要使用多个@ApiImplicitParam注解来描述，多个@ApiImplicitParam注解需要放在一个@ApiImplicitParams注解中。

    @ApiImplicitParams({@ApiImplicitParam(name = "userId",value = "用户Id")})
    @GetMapping("/getAccountInfo")
    public AjaxResult getAccountInfo(@RequestParam("userId")String userId) {
        return userService.getAccountInfo(userId);
    }