接口说明

目录

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

api 文档下的大部分接口商户 api 也通用

测试域名

用户 api

http://www.example.com/api/接口版本/

商户 api

http://www.example.com/merapi/接口版本/

接口版本

v1

北京时间格式

YYYY-mm-dd HH:ii:ss

公共入参说明

注意是通过Url传递 例如 `http://www.example.com/api/v1/member/info

Query 入参说明

Header 入参说明

公共出参说明

出参说明

成功返回

{
    "code": 200,
    "message": "ok",
    "data": [
    
    ]
}

错误返回

{
    "code": 422,
    "message": "错误说明",
    "data": [
    
    ]
}

header出参说明

注意：如果自行修改了系统默认的首页查询，需要自行设置header头

公用请求方法

针对不同操作，服务器向用户返回的结果应该符合以下规范。

如果想自定义控制器内的方法(不包含：index/view/create/update/delete)，需要自行在rule里面配置extraPatterns

公共状态码说明

• 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: 内部服务器错误。 这可能是由于内部程序错误引起的。