Swagger 常用注解说明

@Api（）用于类

表示表示这个类是swagger的资源

Tags-表示说明

Value-也是说明，可以用tags替代

 

Demo:

@Api(value="用户control"，tags={"用户操作接口"})

@RestController

Public class Usercontroller{}

 

@APIOperation（）用于方法

表示一个http请求

value用于方法藐视

notes用于提示内容

tags可以重新分组（视情况而用）

@ApiParam（）用于方法，参数，字段说明

表示对参数添加元数据（说明或是否必填等）

Name参数名

Value-canshushuomng

Required-是否必填

 

Demo:

@Api(value="用户controller",tags={"用户操作接口"}) @RestController public class UserController { @ApiOperation(value="获取用户信息",tags={"获取用户信息copy"},notes="注意问题点") @GetMapping("/getUserInfo") public User getUserInfo(@ApiParam(name="id",value="用户id",required=true) Long id,@ApiParam(name="username",value="用户名") String username) { // userService可忽略，是业务逻辑 User user = userService.getUserInfo(); return user; } }

 

 

 

@ApiModel( )用于类

表示对类进行说明，用于参数用实体类接收

Value-表示对象名

description-描述

都可省略

@APIModelProperty（） 用于方法，字段

表示对model属性的说明或者数据操作更改

Value-字段说明

Name-重写属性名字

dataType-重写属性类型

required-是否必填

Example-举例说明

Hidden-隐藏

@Apilgnore()用于类，方法，方法参数

表示这个方法或者类被忽略

@ApilmplicitParam（）用于方法

1. name ：参数名。 

2. value ： 参数的具体意义，作用。 

3. required ： 参数是否必填。 

4. dataType ：参数的数据类型。 

5. paramType ：查询参数类型，这里有几种形式：

类型	作用
path	以地址的形式提交数据
query	直接跟参数完成自动映射赋值
body	以流的形式提交 仅支持POST
header	参数在request headers 里边提交
form	以form表单的形式提交 仅支持POST

 

 

 

 

表示单独的请求参数

@ApilmplicitParams()用于方法，包含多个@ ApilmplicitParam

Name-参数名

value-参数说明

datatype-数据类型

paramType-参数类型

Example-举例说明

 

Demo

@ApiOperation("查询测试") @GetMapping("select") //@ApiImplicitParam(name="name",value="用户名",dataType="String", paramType = "query") @ApiImplicitParams({ @ApiImplicitParam(name="name",value="用户名",dataType="string", paramType = "query",example="xingguo"), @ApiImplicitParam(name="id",value="用户id",dataType="long", paramType = "query")}) public void select(){ }