1. 需求分析
在接收到任务之后,我们需要查看任务涉及到的模块,需要快速熟悉业务,熟悉业务的参考就是原型文档和PRD文档,我们接下来要开发的床位相关的接口,那么就详细查看床位相关的原型图即可。
特殊情况,新需求可能会没有原型图,这时就需要跟产品经理要多沟通,直至搞明白需求为止
2. 接口四要素
搞明白需求之后,我们下面就可以来设计接口了,一个接口包含了四个基本要素,分别是:请求路径、请求方式、接口入参(请求参数)、接口出参(响应参数)
- 请求路径 命名:以模块名称进行区分(英文)
- 请求方式(需要符合restFul风格)
- 查询 GET
- 新增 POST
- 修改 PUT
- 删除 DELETE
- 接口入参(请求参数)
- 路径参数
- 问号传参---->后端形参接收
- path传参---->后端PathVariable注解接收
- 请求体参数
- 前端:json对象
- 后端:对象接收,DTO
- 接口出参(响应参数)
- 统一格式
{code:200,msg:"成功",data:{}}
- 数据封装,一般为VO
- 敏感数据过滤
- 整合数据
3. 接口测试
测试工具有很多,以下几个是比较常见的接口测试工具
- Postman
- Apifox
- Swagger 在线接口文档
- Knife4j 对swagger的增强,可生成离线接口文档
使用postman或者apifox工具测试接口,需知道明确的接口信息