接口文档概述

  • 本文供前端开发工程师使用
  • 接口请求地址统一格式为: http://api.zzpan.net/api?v=v1&method=user.get 其中:
    • v: 版本号,非必填,如:v1 , 默认为v1
    • method: 调用的接口名称,如:user.get
  • 支持的请求动作有 GET/POST/GET,POST 等三种情况
  • 返回格式仅支持json格式,下面是几个完整的json示例:
    • {"code":200,"msg":"success","data":null}
    • {"code":500,"msg":"请传入xx字段","data":""}
    • {"code":501,"msg":"登陆错误","data":""}
    • {"code":200,"msg":"success","data":[]}
    • {"code":200,"msg":"success","data":[{a:1,b:2},{a:3,b:4}]}
    其中返回的字段:
    • code:整数,状态码。其中200表示成功(http协议状态码为200);其他非200,如500,表示出现错误(http协议状态码为500)
    • msg:字符串,返回的提示消息
    • data:返回的具体数据
  • 输入参数校验的类型
    • required: 必填
    • trim: 清空输出参数的前后空格
    • number: 数字
    • boolean: 布尔验证, 请传入 1或者0
    • date: 日期格式
    • email: 邮箱地址
    • url: url地址
    • ip: ip地址
    • in: 范围内验证。 eg:in:1|2|3 表示输入的值必须是 1,2,3 其中的一个值
    • _xxxx: 带有下划线开头表示自定义验证