本文共 3448 字，大约阅读时间需要 11 分钟。

@Api：用在请求的类上，表示对类的说明    tags="说明该类的作用，可以在UI界面上看到的注解"    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

示例：

@Api(value="用户controller",tags={
   "用户操作接口"})@RestControllerpublic class UserController {
   }

@ApiOperation：用在请求的方法上，说明方法的用途、作用    value="说明方法的用途、作用"    notes="方法的备注说明"@ApiParam()：用于方法，参数，字段说明，是否必填等	name="参数名"	value="参数说明"	required="是否必填"

示例：

@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="隐藏"

示例：

@ApiModel(value="user对象",description="用户对象user")public class User implements Serializable{
       private static final long serialVersionUID = 1L;     @ApiModelProperty(value="用户名",name="username",example="xingguo")     private String username;     @ApiModelProperty(value="状态",name="state",required=true)      private Integer state;      private String password;      private String nickName;      private Integer isDeleted;      @ApiModelProperty(value="id数组",hidden=true)      private String[] ids;      private List
   
     idList;     //省略get/set}  @ApiOperation("更改用户信息")  @PostMapping("/updateUserInfo")  public int updateUserInfo(@RequestBody @ApiParam(name="用户对象",value="传入json格式",required=true) User user){
        int num = userService.updateUserInfo(user);     return num;  }
   

@ApiIgnore()：用于类或方法上，可以不被swagger显示在页面上

@ApiImplicitParams：用在请求的方法上，表示一组参数说明    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面        name：参数名        value：参数的汉字说明、解释        required：参数是否必须传        paramType：参数放在哪个地方            · header --> 请求参数的获取：@RequestHeader            · query --> 请求参数的获取：@RequestParam            · path（用于restful接口）--> 请求参数的获取：@PathVariable            · body（不常用）            · form（不常用）            dataType：参数类型，默认String，其它值dataType="Integer"               defaultValue：参数的默认值

示例：

@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")})

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

示例：

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

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

示例：

import io.swagger.annotations.ApiModel;import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @ApiModel(description= "返回响应数据")public class RestMessage implements Serializable{
        @ApiModelProperty(value = "是否成功")    private boolean success=true;    @ApiModelProperty(value = "返回对象")    private Object data;    @ApiModelProperty(value = "错误编号")    private Integer errCode;    @ApiModelProperty(value = "错误信息")    private String message;     /* getter/setter */}

转载地址：http://lapqb.baihongyu.com/