swagger2 注解整体说明

Easter79
• 阅读 572
@Api:用在请求的类上,表示对类的说明
 2     tags="说明该类的作用,可以在UI界面上看到的注解"
 3     value="该参数没什么意义,在UI界面上也看到,所以不需要配置"
 4 
 5 @ApiOperation:用在请求的方法上,说明方法的用途、作用
 6     value="说明方法的用途、作用"
 7     notes="方法的备注说明"
 8 
 9 @ApiImplicitParams:用在请求的方法上,表示一组参数说明
10     @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
11         name:参数名
12         value:参数的汉字说明、解释
13         required:参数是否必须传
14         paramType:参数放在哪个地方
15             · header --> 请求参数的获取:@RequestHeader
16             · query --> 请求参数的获取:@RequestParam
17             · path(用于restful接口)--> 请求参数的获取:@PathVariable
18             · body(不常用)
19             · form(不常用)    
20         dataType:参数类型,默认String,其它值dataType="Integer"       
21         defaultValue:参数的默认值
22 
23 @ApiResponses:用在请求的方法上,表示一组响应
24     @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
25         code:数字,例如400
26         message:信息,例如"请求参数没填好"
27         response:抛出异常的类
28 
29 @ApiModel:用于响应类上,表示一个返回响应数据的信息
30             (这种一般用在post创建的时候,使用@RequestBody这样的场景,
31             请求参数无法使用@ApiImplicitParam注解进行描述的时候)
32     @ApiModelProperty:用在属性上,描述响应类的属性

swagger2 注解整体说明

1. @Api:用在请求的类上,说明该类的作用

1 @Api:用在请求的类上,说明该类的作用
2     tags="说明该类的作用"
3     value="该参数没什么意义,所以不需要配置"

示例:

1   @Api(tags="APP用户注册Controller")

2. @ApiOperation:用在请求的方法上,说明方法的作用

1 @ApiOperation:"用在请求的方法上,说明方法的作用"
2     value="说明方法的作用"
3     notes="方法的备注说明"

示例:

1  @ApiOperation(value="用户注册",notes="手机号、密码都是必输项,年龄随边填,但必须是数字")

3. @ApiImplicitParams:用在请求的方法上,包含一组参数说明

swagger2 注解整体说明

1 @ApiImplicitParams:用在请求的方法上,包含一组参数说明
 2     @ApiImplicitParam:用在 @ApiImplicitParams 注解中,指定一个请求参数的配置信息       
 3         name:参数名
 4         value:参数的汉字说明、解释
 5         required:参数是否必须传
 6         paramType:参数放在哪个地方
 7             · header --> 请求参数的获取:@RequestHeader
 8             · query --> 请求参数的获取:@RequestParam
 9             · path(用于restful接口)--> 请求参数的获取:@PathVariable
10             · body(不常用)
11             · form(不常用)    
12         dataType:参数类型,默认String,其它值dataType="Integer"       
13         defaultValue:参数的默认值

swagger2 注解整体说明

示例:

@ApiImplicitParams({
    @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),
    @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),
    @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")
})

4. @ApiResponses:用于请求的方法上,表示一组响应

1 @ApiResponses:用于请求的方法上,表示一组响应
2     @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
3         code:数字,例如400
4         message:信息,例如"请求参数没填好"
5         response:抛出异常的类

示例:

1 @ApiOperation(value = "select1请求",notes = "多个参数,多种的查询参数类型")
2 @ApiResponses({
3     @ApiResponse(code=400,message="请求参数没填好"),
4     @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
5 })

5. @ApiModel:用于响应类上,表示一个返回响应数据的信息

1 @ApiModel:用于响应类上,表示一个返回响应数据的信息
2             (这种一般用在post创建的时候,使用@RequestBody这样的场景,
3             请求参数无法使用@ApiImplicitParam注解进行描述的时候)
4     @ApiModelProperty:用在属性上,描述响应类的属性

示例:

swagger2 注解整体说明

1 import io.swagger.annotations.ApiModel;
 2 import io.swagger.annotations.ApiModelProperty;
 3 
 4 import java.io.Serializable;
 5 
 6 @ApiModel(description= "返回响应数据")
 7 public class RestMessage implements Serializable{
 8 
 9     @ApiModelProperty(value = "是否成功")
10     private boolean success=true;
11     @ApiModelProperty(value = "返回对象")
12     private Object data;
13     @ApiModelProperty(value = "错误编号")
14     private Integer errCode;
15     @ApiModelProperty(value = "错误信息")
16     private String message;
17 
18     /* getter/setter */
19 }

该文章全篇转载自:https://www.cnblogs.com/jstarseven/p/11458919.html,如有侵权,请联系删除

点赞
收藏
评论区
推荐文章
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Wesley13 Wesley13
3年前
@Transactional注解详细解读
@Transactional注解可以作用于接口、接口方法、类以及类方法上1\.当作用于类上时,该类的所有public方法将都具有该类型的事务属性2\.当作用在方法级别时会覆盖类级别的定义3\.当作用在接口和接口方法时则只有在使用基于接口的代理时它才会生效,也就是JDK动态代理,而不是Cglib代理4\.当在protect
Stella981 Stella981
3年前
Spring @Async使用
@EnableAsync开启@Async注解功能一、功能@Async注解标记的方法可以使该方法异步的进行调用,如果在类上使用该注解,那么这个类的所有方法都会作为异步方法进行调用注意点,Async注解是基于SpringAop进行实现的,所以在相同的一个类中,方法互相调用是不会起到异步执行的作用的,这里多说一句,任何使用springaop代理实现的
Wesley13 Wesley13
3年前
@JsonProperty注解的使用
遇到一个问题,前端按照平常方式传给我json对象,属性名和我一致,我在controller层也按平常方式使用@RequestBody注解,用相应的实体类接收参数,但别人可以成功接到参数,而我的却不能,在实体类的成员变量上增加@JsonProperty("属性名"),就解决了问题查了一下这个注解:@JsonProperty此注解用于属性上,作用是把该
Easter79 Easter79
3年前
Spring注解大全,汇总版
Spring使用的注解大全和解释注解解释@Controller组合注解(组合了@Component注解),应用在MVC层(控制层),DispatcherServlet会自动扫描注解了此注解的类,然后将web请求映射到注解了@RequestMapping的方法上。@Service组合注解(组合了@Component注解),应用在
Easter79 Easter79
3年前
Swagger文档化restful接口
1、注解@Api:用在类上,说明该类的作用。@ApiOperation:注解来给API增加方法说明。@ApiImplicitParams :用在方法上包含一组参数说明。@ApiImplicitParam:用来注解来给方法入参增加说明。@ApiResponses:用于表示一组响应@ApiResponse:用在@ApiResponses
Wesley13 Wesley13
3年前
Java构造方法与析构方法实例剖析
Java构造方法类有一个特殊的成员方法叫作构造方法,它的作用是创建对象并初始化成员变量。在创建对象时,会自动调用类的构造方法。构造方法定义规则:Java中的构造方法必须与该类具有相同的名字,并且没有方法的返回类型(包括没有void)。另外,构造方法一般都应用public类型来说明,这样才能在程序任意的位置创建类的实例-
Stella981 Stella981
3年前
Redis 配置
在Redis的使用过程,除了知道对Redis五种数据类型的操作方法之外,最主要额就是对redis.conf进行配置了,下面整理出redis.conf中常见的一些配置介绍。参数说明redis.conf配置项说明如下:1:Redis默认不是以守护进程的方式运行,可以通过该配置项修改,使用yes启用守护进程
Easter79 Easter79
3年前
SpringMVC学习(二)@Requestmapping映射和Rest风格
1、@RequestMapping1.1、@RequestMapping映射请求注解在SpringMVC中使用@RequestMapping注解可以为控制器指定处理哪些URL请求可以用于类上或者方法上类定义处:提供初步的请求映射信息。相对于WEB应用
Wesley13 Wesley13
3年前
Java中的static关键字解析
一.static关键字的用途: 在《Java编程思想》P86页有这样一段话: _“static方法就是没有this的方法。在static方法内部不能调用非静态方法,反过来是可以的。而且可以在没有创建任何对象的前提下,仅仅通过类本身来调用static方法。这实际上正是static方法的主要用途。”_  这段话虽然只是说明了static方法
Easter79
Easter79
Lv1
今生可爱与温柔,每一样都不能少。
文章
2.8k
粉丝
5
获赞
1.2k