目录

通用请求及响应示例

不同的 Web API 的请求与响应中有相同的数据内容，为使文档简洁，这些数据内容均以“通用XXX”表示。

请求

GET/POST https://example.com/api.php

Headers

以下简称“通用请求头”：

参数 示例值 说明
Content-Type application/json; charset=utf-8 客户端发送的内容类型
Accept-Encoding gzip, deflate 客户端接受的压缩算法
User-Agent Mozilla/5.0 -
Accept-Language zh-cn 客户端接受的语言代码
Authorization emhvdXppc2h1fHx8ZWQyZTk2OG… 鉴权头

Cookies

以下简称“通用请求 Cookies”：

键 示例值 域 路径 过期
addinfo xxxxxxxxxx example.com / -
http304ok 1 example.com / -
timezone 8 example.com / -

Body

无

响应

Headers

以下简称“通用响应头”：

参数 示例值 说明
Content-Type application/json; charset=utf-8 响应内容的类型
Content-Encoding gzip 响应使用的压缩算法
Date Sun, 23 Feb 2020 07:03:41 GMT 响应的时间

Cookies

无

Body

以下简称“通用响应体”。

根据客户端的身份验证以及服务端的状态返回内容。

例如： 

{
    "message": "OK",
    "data": {},
    "error": null
}

data 内容由具体的接口决定，一些常见的范例如下：

如，某个用于添加内容的接口。

用 code 是否为 200 表示是否添加成功。

message 传递相应消息，内容无规定。

其他操作以此类推。 

{
    "message": "OK",
    "data": null,
    "error": null
}

{
    "message": "删除失败，该资源不存在！",
    "data": null,,
    "error": null
}