Swagger（二）：Swagger相关注解使用（持续更新）

前言

昨天把SpringBoot整合Swagger以及测试接口整理了一下，今天把一些我目前所用到的有关Swagger的注解整理一下，最近一段时间从网上搜了很多有关Swagger的注解，经常用的其实很少，所以写这篇文章主要就是把那些我最近常用的Swagger注解整理出来，至于以后用到了哪些Swagger的注解可以在加上，这也是为什么我这篇文章要标上持续更新的原因。

各位小伙伴想要了解SpringBoot如何配置Swagger请跳转至SpringBoot整合Swagger

Swagger注解

先在这里说一下，每一个Swagger的注解的属性都很多，但是用到的很少，我下面就只贴我用到的，一般每个注解常用的属性就是以下几个属性：

1. value：属性说明
2. required：是否必传
3. example：参数默认值

一、@Api注解

该注解主要是作用在类上，如下代码

@RestController
@RequestMapping(value = "user")
@Api(value = "user",tags = "用户接口")
public class UserController {
   
}

这个注解主要的作用就是说明这个Controller类是做什么的，下面贴一下效果图

二、@ApiOperation注解

该注解主要作用于方法之上，表名该方法是做什么的，如下代码

	@RequestMapping(value = "add",method = RequestMethod.POST)
    @ApiOperation(value = "添加用户")
    public String add(AddUserParam param){
   
        userService.addUser(param);
        return "添加成功";
    }

效果图：

三、@ApiParam注解

该注解主要作用于参数上，如下代码