接口如何定义

接口设计完成之后，需要出接口文档。根据要求可以出word类型、excel类型都可以；如果没有特殊要求，使用swagger生成接口文档较为方便。

根据接口设计的内容编写controller方法，最后通过swagger生成接口文档。

1.  编写controller方法

/**
* 示例接口
*/
@RestController("operationServeController")
@RequestMapping("/manager/serve")
@Api(tags = "管理端 - 区域服务相关接口")
public class ServeController {@GetMapping("/page")@ApiOperation("区域服务分页查询")public PageResult<ServeResDTO> page(ServePageQueryReqDTO servePageQueryReqDTO) {return null;}
}

说明如下：

@RestController("operationServeController") 指定名称operationServeController防止同类名的bean名称相同。

@RequestMapping("/manager/serve") 指定本controller的根路径。

@Api(tags = "管理端 - 区域服务相关接口") 接口文档显示。

@GetMapping("/page") Get请求。

当请求参数格式为json需要在方法参数前加@RequestBody注解，这里请求参数类型为from表单格式不用添加此注解。

分页查询参数类型统一继承PageQueryDTO类型。

分页查询结果统一使用PageResult类。

2. 查看接口文档

接口定义好后前端工程师需要参考接口内容编写前端代码，下边介绍接口文档的生成方法。

本项目的接口文档使用swagger，具体使用knife4j-spring-boot-starter组件生成接口文档。

首先重启服务，访问http://localhost:端口/doc.html，查看区域服务模块的接口文档，根据接口文档的内容审查是否与接口设计一致。

3. 测试接口

Java程序员可以使用接口文档测试接口，下边说明测试方法。

首先在controller方法打断点，进入接口调试界面，输入请求参数，点击“发送”，跟踪断点请求参数是否正确，跟踪响应内容。

审查和测试通过之后，就可以将接口交予前端，同步进行前后端分离开发。