qimall/docs/guide_zh_cn/api/api-explain.md

接口说明

目录

• 测试域名
• 接口版本
• 北京时间格式
• 公共头部参数
• 公共出参说明
• 公共状态码说明

接口域名

用户 api

http://106.52.144.247:3000/project/249/interface/api

接口版本

v1

北京时间格式

YYYY-mm-dd HH:ii:ss

公共入参说明

请求参数

Headers：

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body:

名称	类型	是否必须	默认值	备注	其他信息
avatar_url	string	非必须		头像
birthday	string	非必须		生日：2021-10-8
nickname	string	非必须		昵称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	string []	非必须			item 类型: string
		非必须

公共状态码说明

• 200: OK。一切正常。

• 201: 响应 POST 请求时成功创建一个资源。Location header 包含的URL指向新创建的资源。

• 204: 该请求被成功处理，响应不包含正文内容 (类似 DELETE 请求)。

• 304: 资源没有被修改。可以使用缓存的版本。

• 400: 错误的请求。可能通过用户方面的多种原因引起的，例如在请求体内有无效的JSON 数据，无效的操作参数，等等。

• 401: 验证失败。

• 403: 已经经过身份验证的用户不允许访问指定的 API 末端。

• 404: 所请求的资源不存在。

• 405: 不被允许的方法。 请检查 Allow header 允许的HTTP方法。

• 415: 不支持的媒体类型。 所请求的内容类型或版本号是无效的。

• 422: 数据验证失败 (例如，响应一个 POST 请求)。 请检查响应体内详细的错误消息。

• 429: 请求过多。 由于限速请求被拒绝。

• 500: 内部服务器错误。 这可能是由于内部程序错误引起的。

详细的接口文档地址:http://106.52.144.247:3000/