前后端联调规范总结

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了前后端联调规范总结相关的知识,希望对你有一定的参考价值。

参考技术A 1、http状态码规范:
2xx:前端向服务器请求成功,但是返回了有可能的多种状态
3xx:缓存,重定向
4xx:找不到路径
5xx:服务器内部故障

2、返回的response:

其中的data可以为null。
其他字段:
statusCode:主体状态
code:详细状态
message:请求结果信息

3、分页数据

请求参数:
pageIndex当前页码,从1开始
pageSize每页多少条数据

response.data必需字段如下:
total_page总页数
curr_size当前页码
list数据列表

4、关于鉴权
用户通过账号密码或手机号验证码的方式登陆成功,服务端据此创建一个session会话秘钥,同时创建一个hash加密后的token,塞到客户端header中。
然后客户端的每次请求都会携带这个token,后端判断是否过期,过期就重新登录

小程序登录原理是依据的微信的会话,登录时,微信服务器生成一个sessionid和code,code返回到客户端,客户端携带code去自己服务端请求,自己服务器对比sessionid和code,不一致就判定位过期。
小程序不需要每次都授权登录,可以通过携带code静默登录,不会掉起授权窗口。
并且使用token请求,服务端返回401token过期后,客户端可以直接自动重新登录。
详见 https://www.jianshu.com/p/8b51ad14607f

工作---前后端联调

 

 

 

一、前后端联调之前

当页面的布局和逻辑开发都实现后,后端的的接口没有开发出来的时候,我们可以先进行Mock数据,在已有接口文档的情况下,我们可以直接按照接口文档来开发,通过mock语法来编写相对应的字段和数据。常用的mock数据方式有json-server mockjs easy-mock. rap2等方式

 

二、什么是前后端联调

之前开发写代码的时候,所有的ajax数据都不是后端返回的真实数据,而是我们自己通过接口mock模拟的假数据,当前端的代码编写完毕,后端的接口也已经写好之后,我们就需要把mock数据干掉,尝试使用后端提供的数据,进行前后端的一个调试,这个过程我们就把它称之为前后端的接口联调。

 

三、为什么要联调

我们在本地编写的mock数据肯定是符合前端标准的,但是后端接口首先需要测试通不通,还需要测试数据格式对不对,还有后端有没有填写足够的数据,比如写列表页,前端想分页

以上是关于前后端联调规范总结的主要内容,如果未能解决你的问题,请参考以下文章

前后端分离接口规范

前后端分离接口规范~

前后端分离后,接口联调总是甩锅怎么办?

DRF0. 前后端分离

前后端分离接口规范 ,看这一份就够了 !

深入浅出:了解前后端分离优势前后端接口联调以及优化问题