首先需求确定之后,我们会根据产品原型和需求文档来设计接口,我们项目中是遵循了Restful风格的规范。主要包含了几个部分
- 请求路径:一般都是以资源名称或者小模块名称进行命名
- 请求方式
- 查询是get请求
- 新增是post请求
- 修改是put请求
- 删除是delete请求
- 接口的入参,一般也有两种形式
- 其中get请求会使用问号传参或者是path路径传参,后端使用形参接收参数
- 如果是put或者post请求会使用json对象传参,后端需要使用dto去接收参数
- 接口的出参,我们项目中定义了统一的接口规范
- 如果返回数据较多,一般会封装一个vo进行返回,vo可以过滤敏感数据,或者是整合数据