接口开发方法论

一. 操作页面需求分析

1.需要一共几个CURD

2.确认url,入参

3.对应的接口需要返回的数据有那些? 建立响应数据模型

二. 非操作页面需求下来

1.分析需求,要完成什么功能?

2.方案论证,难点分析,疑点确认

3.编码实现

三.接口定义

定义一个接口需要包括以下几个方面：

1）协议 

通常协议采用HTTP，查询类接口通常为get或post，查询条件较少的使用get，较多的使用post。

本接口使用 http post。

还要确定content-type，参数以什么数据格式提交，结果以什么数据格式响应。

一般情况没有特殊情况结果以json 格式响应。

2）分析请求参数

根据前边对数据模型的分析，请求参数为：课程名称、课程审核状态、当前页码、每页显示记录数。

根据分析的请求参数定义模型类。

3）分析响应结果

根据前边对数据模型的分析，响应结果为数据列表加一些分页信息（总记录数、当前页、每页显示记录数）。

数据列表中数据的属性包括：课程id、课程名称、任务数、创建时间、审核状态、类型。

注意：查询结果中的审核状态为数据字典中的代码字段，前端会根据审核状态代码 找到对应的名称显示。

根据分析的响应结果定义模型类。

4）分析完成，使用SpringBoot注解开发一个Http接口。

5）使用接口文档工具查看接口的内容。

6）接口中调用Service方法完成业务处理。