后端进行接口设计的注意点

接口的设计和定义

这里使用注册功能进行演示

①请求方式

选项	方案
请求方式	post
请求地址	/register/

②请求参数:表单参数

参数名	类型	是否必传	说明
username	string	是	用户名
password	string	是	密码
password2	string	是	确认密码
mobile	string	是	手机号
sms_code	string	是	短信验证码

③相应结果:HTML

响应结果	相应内容
注册失败	相应错误提示
注册成功	重定向到首页

总结:

1.对于接口的设计,我们要根据具体的业务逻辑,设计出适合业务逻辑的接口

2.设计接口的思路

• 分析要实现的业务逻辑
  -------明确这个业务中涉及到的相关子业务
  -------将每个子业务当作一个接口来设计
• 分析接口的功能任务,明确接口的访问方式与返回数据
  ----请求方式----接口的请求方式,如GET,POST,PUT等
  ----请求路径----接口的URL路径定义
  ----请求参数----请求参数(如路径参数,查询字符串,表单,JSON等)
  ----响应数据----响应数据(HTML,JSON等)