JSON数据类型
JSON是一种轻量级的数据交换格式,它支持一下数据类型:
- 数字型(Number):双精度浮点型格式
- 字符串型(String):双引号包裹的 Unicode 字符和反斜杠转义字符
- 布尔型(Boolean):true 或 false
- null:表示空值
- 数组(Array):使用方括号 [...] 中书写,可以包含多个值
- 对象(Object):使用大括号 {...} 中书写,可以包含多个 key/value 对,key 必须是字符串,value 可以是任意 JSON 数据类型
网络请求介绍
HTTP协议提供了集中请求方式,每种请求方式都有不同的作用.主要请求方式有7种GET,POST,DELETE,PUT,HEAD,TRACE,OPTIONS.其中PUT,DELETE,POST,GET分别对应了资源的增删查改4个功能,也是客户端中运用最多的4个请求.
PUT请求
前后端API规范
一、基础规范
- 请求与响应格式:所有请求和响应都应采用JSON格式。
- 编码:统一采用UTF-8编码。
二、接口规范
每个接口都应包含简短的描述,确接口的URL,包括正式环境和测试环境的地址。
由前端(APP端)和后端一起协定接口规范的内容, 确定每一个接口的地址(URL), 输入(request)和输出(response), 必要的时候详细注释每一个字段的含义和数据类型.
具体需要定义哪些接口, 可以按照下面的思路来整理
- 资源接口: 系统涉及到哪些资源, 按照 RESTful 方式定义的细粒度接口
- 操作接口: 页面涉及到哪些操作, 例如修改购物车中商品的数量, 更换优惠券等等, 也可以使用 RESTful 方式来定义
- 页面接口: 页面涉及到太多接口, 如果是一个个地调用, 会需要很多次请求, 有可以影响到前端的性能和用户感知(特别是首屏的体验), 因此可能需要将这些接口的数据合并到一起, 作成一个聚合型接口提供给前端来使用
三、请求方法
常见的请求方法包括GET、POST、PUT、DELETE等,应根据接口的功能选择合适的请求方法。
四、请求参数
- 参数名称:明确每个参数的名称。
- 参数类型:说明参数的数据类型,如字符串、整数、布尔值等。
- 参数说明:对参数进行简短的描述。
- 是否必填:明确哪些参数是必填的,哪些是可选的。
五、响应内容
- 状态码:表示请求的成功或失败,如200表示成功,404表示未找到等。
- 响应数据:返回的数据结构应清晰明了,包括必要的字段和值。
- 错误信息:如果请求失败,应返回详细的错误信息,帮助开发者快速定位问题。
七、错误代码
对接口可能出现的错误进行分类,并为每类错误分配唯一的错误代码。这有助于前端开发者快速识别和处理错误。