前后端分离的接口规范是什么?

本文探讨了前后端分离的原因,如关注点分离、职责明确等,并介绍了开发流程,包括后端编写接口文档、前端Mock开发等。重点阐述了接口规范V1.0.0,包括数据返回原则、基本格式、响应实体格式、特殊内容规范,如Boolean类型和日期类型的处理方式,旨在提高开发效率和协同质量。

一、为何要分离
在这里插入图片描述

1、前端开发重度依赖开发环境,开发效率低。
2、前后端职责依旧纠缠不清。
3、对前端发挥的局限。
关注点分离
职责分离
对的人做对的事
更好的共建模式
快速的反应变化

二、开发流程

1、后端编写和维护接口文档,在 API 变化时更新接口文档
2、后端根据接口文档进行接口开发
3、前端根据接口文档进行开发 + Mock平台
4、开发完成后联调和提交测试
5、Mock 服务器根据接口文档自动生成 Mock 数据,实现了接口文档即API:
在这里插入图片描述
三、接口规范V1.0.0
1 规范原则
接口返回数据即显示:前端仅做渲染逻辑处理;
渲染逻辑禁止跨多个接口调用;
前端关注交互、渲染逻辑,尽量避免业务逻辑处理的出现;
请求响应传输数据格式:JSON,JSON数据尽量简单轻量,避免多级JSON的出现;

2 基本格式
请求基本格式
GET请求、POST请求必须包含key为body的入参,所有请求数据包装为JSON格式,并存放到入参body中,示例如下:
GET请求:
xxx/login?body={“username”:“admin”,“password”:“123456”,“captcha”:“scfd”,“rememberMe”:1}
POST请求:
在这里插入图片描述
响应基本

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值