@ApiOperation用法

作用：注解@ApiOperation是用来构建Api文档1.引入依赖在pom文件中引入依赖<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.2.2</version>&lt

文章共458字 · 阅读需要大约2分钟

一键AI生成摘要，助你高效阅读

问答

一片蓝蓝的云

37733人浏览 · 2021-05-29 15:32:03

一片蓝蓝的云 · 2021-05-29 15:32:03 发布

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

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

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>

2.用法

使用于在方法上，表示一个http请求的操作
@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;
    }