Swagger——一个规范和完整的框架，用于接口的文档在线自动生成。

1、描述

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

作用：

1.接口的文档在线自动生成。

2.功能测试。

2、运用

a) maven导入Swagger

b) 创建Swagger2配置类

3、注解及其说明

@Api : 用在类上，说明该类的主要作用。

@ApiOperation：用在方法上，给API增加方法说明。

@ApiImplicitParams : 用在方法上，包含一组参数说明。

@ApiImplicitParam：用来注解来给方法入参增加说明。

@ApiResponses：用于表示一组响应。

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

​ l code：数字，例如400

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

​ l response：抛出异常的类

@ApiModel：用在返回对象类上，描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）

​ l @ApiModelProperty：描述一个model的属性

 

@RestController
@RequestMapping("emp") @Api(value = "用户管理类") public class EmployeeController { ​ @Autowired private EmployeeReposiroty employeeReposiroty;

/**
      * 增加人物
      * @param employee
      * @return
      */

 @PostMapping(value = "employee") 

@ApiOperation(value = "新增一个用户",notes = "新增之后返回对象") 
//@ApiOperation：用在方法上，给API增加方法说明。
@ApiImplicitParam(paramType = "query",name = "employee",value = "用户",required = true)
//@ApiImplicitParam：用来注解来给方法入参增加说明。
@ApiResponse(code = 400,message = "参数没有填好",response = String.class) public String insert(Employee employee){ Employee employee1 = employeeReposiroty.save(employee); if(employee1 != null) { return SysNode.Judge.SUCCESS.getResult(); }else { return SysNode.Judge.FAILD.getResult(); } }

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

/**
    * 删除单个用户
      * @param id
      * @return
      */@DeleteMapping(value = "employee/{id}") //两个参数名必须保持一致 @ApiOperation(value = "删除用户",notes = "根据成员id删除单个用户") @ApiImplicitParam(paramType = "path",name = "id",value = "用户id",required = true,dataType = "Integer") @ApiResponse(code = 400,message = "参数没有填好",response = String.class)
public String delete(@PathVariable("id")Integer id){ //占位映射符  
@PathVariable是spring3.0的一个新功能：接收请求路径中占位符的值
语法：

• @PathVariable("xxx")
•  通过 @PathVariable 可以将URL中占位符参数{xxx}绑定到处理器类的方法形参中@PathVariable(“xxx“) 
• @RequestMapping(value=”user/{id}/{name}”)

  

   

   

 try{ employeeReposiroty.deleteById(id); return SysNode.Judge.SUCCESS.getResult(); }catch (Exception e){ e.printStackTrace(); return SysNode.Judge.FAILD.getResult(); } } ​ /**   * 修改单个成员 * @param employee * @return */ @PutMapping(value = "employee/{id}") @ApiOperation(value = "修改用户信息",notes = "根据成员id修改单个用户") @ApiImplicitParam(paramType = "path",name = "id",value = "用户id",required = true,dataType = "Integer") public String update(Employee employee){ /** * save方法如果参数属性缺失，会导致原本存在的数据为null */ Employee employee1 = employeeReposiroty.saveAndFlush(employee); if (employee1 != null) { return SysNode.Judge.SUCCESS.getResult(); }else { return SysNode.Judge.FAILD.getResult(); } } ​ /**   * 获取所有成员,升序排列 * @return */ @GetMapping(value = "employee/sort") @ApiOperation(value = "查询全部用户",notes = "默认根据升序查询全部用户信息") public List<Employee> findAll(){ Sort orders = new Sort(Sort.Direction.DESC,"employeeId"); List<Employee> employeeList = employeeReposiroty.findAll(orders); return employeeList; } ​ /**  * 获取所有成员,升序排列 * @return */ @GetMapping(value = "employee/pageSort") @ApiOperation(value = "查询用户信息",notes = "查询用户信息") @ApiImplicitParams({ @ApiImplicitParam

转载于:https://www.cnblogs.com/xtxt1127/p/11505641.html