@ApiOperation用法

作用:注解@ApiOperation是用来构建Api文档

1.引入依赖
在pom文件中引入依赖

<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger2artifactId>
    <version>2.2.2version>
dependency>

2.用法

  1. 使用于在方法上,表示一个http请求的操作
  2. @ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response =
    “接口返回参数类型”, notes = “接口发布说明”;其他参数可参考源码;

3.具体例子

    @ApiOperation(value="获取用户列表", notes="")
    @RequestMapping(value={""}, method=RequestMethod.GET)
    public List<User> getUserList() {
        List<User> r = new ArrayList<User>(users.values());
        return r;
    }

你可能感兴趣的:(spring)