API 文档构建工具 - 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”)

})

@ApiResponses

@ApiResponses：用于请求的方法上，表示一组响应

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

code：数字，例如400

message：信息，例如"请求参数没填好"

response：抛出异常的类

@ApiOperation(value = “select请求”, notes = “多个参数，多种的查询参数类型”)

@ApiResponses({

@ApiResponse(code=400, message=“请求参数没填好”),

@ApiResponse(code=404, message=“请求路径没有或页面跳转路径不对”)

})

@ApiModel

@ApiModel：用于响应类上，表示一个返回响应数据的信息

（这种一般用在post创建的时候，使用@RequestBody这样的场景，

请求参数无法使用@ApiImplicitParam注解进行描述的时候）

@ApiModelProperty：用在属性上，描述响应类的属性

@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 */

}

用法展示

其他情况类似

//RestController==controller+responseBody

@Api(tags = “APP用户注册Controller”)

@RestController

public class UserController {

@Autowired

private UserService userService;

@ApiOperation(value = “根据用户id查询用户记录”)

@ApiImplicitParam(name = “userId”, value = “查询参数”, required = true, paramType = “path”)

@GetMapping(“one/{id}”)

public User sayUser(@PathVariable Integer id) {

System.out.println( id + “<<<” );

//根据ID查询

User user = userService.queryUserById( id );

//user–json

return user;

}

@GetMapping(“userOne/{name}”)

@ApiOperation(value = “根据用户名查询用户记录”)

@ApiImplicitParam(name = “userName”, value = “查询参数”, required = true, paramType = “path”)

public User sayUserOne(@PathVariable String name) {

System.out.println( name + “<<<” );

//根据ID查询

User user = userService.queryUserByName( name );

//user–json

return user;

}

// @PutMapping(“add”)

// public ResultInfo sayAdd(User user) {

// ResultInfo result=new ResultInfo();

// System.out.println(user + “<<<”);

// //根据ID查询

// int x= userService.saveUser(user);

// //判断

// if(x>0){

// result.setCode(200);

// result.setMsg(“添加OK”);

// }else{

// result.setCode(500);

// result.setMsg(“添加失败”);

// }

// return result;

// }

@ApiOperation(value = “用户添加”)

@ApiImplicitParam(name = “user”, value = “用户实体类”, dataType = “User”)

@PutMapping(“add”)

public ResultInfo sayAdd(User user) {

ResultInfo result = new ResultInfo();

System.out.println( user + “<<<” );

//根据ID查询

try {

userService.saveUser( user );

} catch (ParamException ex) {

ex.printStackTrace();

//初始化对象信息

result.setCode( ex.getCode() );

result.setMsg( ex.getMsg() );

} catch (Exception ex) {

ex.printStackTrace();

result.setCode( 300 );

result.setMsg( “添加异常了” );

}

return result;

}

@ApiOperation(value = “用户更新”)

@ApiImplicitParam(name = “user”, value = “用户实体类”, dataType = “User”)

@PostMapping(“update”)

public ResultInfo sayUpdate(User user) {

ResultInfo result = new ResultInfo();

System.out.println( user + “<<<” );

//根据ID查询

try {

userService.changeUser( user );

} catch (ParamException ex) {

ex.printStackTrace();

//结果的赋值

result.setMsg( ex.getMsg() );

result.setCode( ex.getCode() );

} catch (Exception ex) {

ex.printStackTrace();

result.setCode( 300 );

result.setMsg( “修改异常了” );

}

return result;

}

@ApiOperation(value = “根据用户id删除用户记录”)

@ApiImplicitParam(name = “userId”, value = “查询参数”, required = true, paramType = “path”)

@DeleteMapping(“delete/{userId}”)

public ResultInfo sayDel(@PathVariable Integer userId) {

ResultInfo result = new ResultInfo();

System.out.println( userId + “<<<” );