api

这是通过AJAX的方式调用的API的入口。所有AJAX请求的最终处理会交由core模块处理。其中params 参数包括了以下部分:

  • ip {string} 对方的IP
  • transport {string} ajax
  • auth {object} 可选,对方如果提供了authorization头,则为解析出的JWT的数据。 如果解析的过程中出错则会直接返回错误。数据包含以下字段:
    • uid {string} 用户ID
    • jti {string} JWT的ID
    • role {Number} 权限
    • iat {Number}
    • exp {Number}
  • query {object} 请求中的query string解析出的对象,支持数组和嵌套对象
  • data {object} POST等请求中的body数据,只支持json和urlencoded,某些接口会支持multipart
  • id {string} 可选,对于某些会包含ID的请求类型,这是URL中的ID
  • file|files 可选,上传的文件,其中文件的值的内容见Multer文档
  • _files {Array.} 这次请求创建的所有临时文件的路径(不仅是上传的文件,比如还包含处理过的图片), 如果返回值不是200或有异常抛出,上述_files中的文件将被删除
  • _dirs {Array.} 这次请求创建的所有临时文件夹,如果返回值不是200或有异常抛出, 上述_dirs将被递归删除