本小节我们将学习如何定义后端的接口。
开发之前,我们得分析后端需要提供哪些接口。
我们可以根据需求文档来进行分析。
第一个功能是用户自动登录,那么我们后端需要提供一个接口实现用户的静默注册,什么是静默注册?我们将在后面的章节详细讲解。
第二个功能是展示搜索热词,那么我们后端需要提供一个接口能够获取系统中的所有热词。
第三个功能是搜索某个词的近义词,那么我们后端需要提供一个接口返回某个词的所有近义词。
第四个功能是对搜索结果点赞,那么我们后端需要提供一个接口可以增加某对近义词的相关强度。
第五个功能是联系与反馈,那么我们后端需要提供一个接口可以接收并保存用户的反馈信息。
第六个功能是给用户发送微信通知,那么我们后端需要提供一个接口给前端获取订阅消息模板的ID。
第七个功能是管理员可以查看所有反馈,那么我们后端需要提供一个接口能够展示用户提交过的所有反馈。
第八个功能是管理员可以删除反馈,那么我们后端需要提供一个接口用来删除指定的一个反馈。
到此,我们已经明确了后端需要提供哪些接口,但接口的详细定义,我们将在后面的章节进行详细讲解。
为了方便前端调用和接口管理,我们必须提前定义好所有接口的返回值格式,无论接口处理的结果是什么,返回给前端的接口都必须是统一的。
我们规定,接口的返回结果格式如下,返回的是一个json对象,里面有三个字段:
第一个字段是errCode,代表的是错误码,0表示调用成功,其它数字代表失败,每个数字代表什么含义,同学们可以根据自己的情况进行定义。
第二个字段是errMsg,代表的是错误信息,用来对错误码的文字解释,要不前端开发者只看到错误码,就会很迷惑。
第三个字段是data,咱们将其它数据都放到这个里面。
想看视频版?
关注公号“微程序学堂”,我们的视频教程即将上线
如果你自己写了好文章想投稿
请联系我们