SpringBoot | 第十章：Swagger2的集成和使用

3.添加文档内容(一般上是在Controller，请求参数上进行注解，这里以上章节的UserController进行配置)

UserController

@RestController
@RequestMapping("/user")
@Api(tags="用户API")
public class UserController {

    @Autowired
    IUserService userService;

    @PostMapping("add")
    @ApiOperation(value="用户新增")
    //正常业务时， 需要在user类里面进行事务控制，控制层一般不进行业务控制的。
    //@Transactional(rollbackFor = Exception.class)
    public Map addUser(@Valid @RequestBody UserReq userReq){

 User user = new User();
 user.setCode(userReq.getCode());
 user.setName(userReq.getName());
 //由于设置了主键策略 id可不用赋值 会自动生成
 //user.setId(0L);
 userService.insert(user);
 Map result = new HashMap();
 result.put("respCode", "01");
 result.put("respMsg", "新增成功");
 //事务测试
 //System.out.println(1/0);
 return result;
    }

    @PostMapping("update")
    @ApiOperation(value="用户修改")    
    public Map updateUser(@Valid @RequestBody UserReq userReq){

 if(userReq.getId() == null || "".equals(userReq.getId())) {
     throw new CommonException("0000", "更新时ID不能为空");
 }
 User user = new User();
 user.setCode(userReq.getCode());
 user.setName(userReq.getName());
 user.setId(Long.parseLong(userReq.getId())); 
 userService.updateById(user);
 Map result = new HashMap();
 result.put("respCode", "01");
 result.put("respMsg", "更新成功");
 return result;
    }

    @GetMapping("/get/{id}")
    @ApiOperation(value="用户查询(ID)")    
    @ApiImplicitParam(name="id",value="查询ID",required=true)
    public Map getUser(@PathVariable("id") String id){
 //查询
 User user = userService.selectById(id);
 if(user == null) {
     throw new CommonException("0001", "用户ID：" + id + "，未找到");
 }
 UserResp resp = UserResp.builder()
  .id(user.getId().toString())
  .code(user.getCode())
  .name(user.getName())
  .status(user.getStatus())
  .build();
 Map result = new HashMap();
 result.put("respCode", "01");
 result.put("respMsg", "成功");
 result.put("data", resp);
 return result;
    }

    @GetMapping("/page")
    @ApiOperation(value="用户查询(分页)") 
    public Map pageUser(int current, int size){
 //分页
 Page page = new Page<>(current, size);
 Map result = new HashMap();
 result.put("respCode", "01");
 result.put("respMsg", "成功");
 result.put("data", userService.selectPage(page));
 return result;
    }

}

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
//加入@ApiModel
@ApiModel
public class UserReq {

    @ApiModelProperty(value="ID",dataType="String",name="ID",example="1020332806740959233")
    String id;

    @ApiModelProperty(value="编码",dataType="String",name="code",example="001")
    @NotBlank(message = "编码不能为空")
    String code;

    @ApiModelProperty(value="名称",dataType="String",name="name",example="oKong")
    @NotBlank(message = "名称不能为空")
    String name;
}