后端接口通用开发流程
2020-10-13 13:48:39 0 举报
AI智能生成
后端接口开发通用流程
作者其他创作
大纲/内容
根据问题提取功能接口(入参、返回值),确定接口文档
确定接口所在模块
创建空白文档
确定接口地址、请求类型、接口描述
确定请求参数(如果没有参数不用做这一步)
1、参数个数
2、参数名字
3、参数类型
4、参数描述
确定响应参数(一般都是统一返回对象)
接口测试成功后,完善成功和失败示例
三层架构构建(控制层、业务层、数据层),三层架构相关的类和接口创建完毕
根据接口所在模块构建(如果已经存在,不需要重复构建)
完善具体功能代码(核心是业务层),接口测试成功(使用接口测试工具)
参数校验
思考完成该功能需要几个步骤
写控制层代码(路径、入参) ==根据接口文档写
写一个方法,方法名和接口文档中请求路径相同,传参个数和类型也和接口文档中相同,返回值类型是统一返回类
在方法上写请求类型注解(get或者set),并在注解内部写上请求路径(跟接口文档相同)
写业务层接口方法规则(方法名跟控制层相同)
写业务层接口实现类代码,重写业务层接口中的方法(根据具体业务写代码)
完成该功能需要几个步骤(写注释)
根据需要做的事,找到需要的数据(这里使用数据层功能,多次循环直到完成该功能需要的几个步骤完成)
要查的数据在哪个表里,就使用对应的数据层接口和映射文件
使用@Autowired在当前业务层中注入要使用的数据层接口
确定是增删改查哪一种数据操作,写具体代码(如果是查询,确定是查一个还是查多个)
在数据层接口写方法规则时,注意参数列表的个数
在数据层映射文件中,注意是增删改查哪一种、入参数据类型、返回值使用resultMap、sql语句
把最终找到的数据,放到统一返回类对象中的data属性里
数据层接口和数据层映射文件中的代码,根据业务层中的业务功能需求去具体写,但是只有增删改查四种数据操作
收尾工作(完善文档,代码写注释)
0 条评论
下一页