注解01：@ApiOperation注解说明

最新推荐文章于 2024-11-05 19:09:43 发布

原创最新推荐文章于 2024-11-05 19:09:43 发布 · 1.6w 阅读

41 ·

CC 4.0 BY-SA版权

文章标签：

#swagger2

Spring 学习专栏收录该内容

3 篇文章

订阅专栏

本文介绍了如何在Spring项目中使用Swagger2创建API文档，包括@ApiOperation和@ApiParam注解的用法，以及如何添加相关依赖。重点讲解了接口说明、参数定义和文档生成的关键步骤。

一、简介：

@ApiOperation 注解不是Spring 自带的，它是swagger里的com.wordnik.swagger.annotations.ApiOperation;
注解@ApiOperation 和@ApiParam是用来构建Api 文档的
@ApiOperation(value="接口说明"，httpMethod="接口请求方式"，response="接口返回参数类型"，notes="接口发布说明")；其他参数可参考源码
@ApiParam(required ="是否必须参数"，name="参数名称",value="参数具体描述")

@ApiOperation: 用在请求的方法上，说明方法的用途、作用

value="说明方法的用途、作用"
notes="方法的备注说明"

二、添加Swagger2 依赖

在pom.xml中加入Swagger2 依赖


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