Skip to content

🤖 API 文档

嘿!这里是 Seaper 的官方 API 文档!如果你是普通用户,请移步到 使用文档,本文档是提供给开发者,以帮助开发者扩展 Seaper 功能而制作的!

API 规范

Seaper 所有的 API 返回都有一个统一的规范(包括请求错误、页面找不到)

json
{
    status: 200,
    time: 000000000000,
    data: {}
}
{
    status: 200,
    time: 000000000000,
    data: {}
}

他们分别为:

  • status -> 状态码
  • time -> 时间戳
  • data -> 返回数据

当 API 文档中,响应参数"-" 时,则意味着 data 根;为 "-.xxxx" 时,则意味着 data 的子键;当含有 "[]" 时,则意味着为数组内的内容

json
{
    status: 200,
    time: 000000000000,
    data: xxx
}
{
    status: 200,
    time: 000000000000,
    data: xxx
}
json
{
    status: 200,
    time: 000000000000,
    data: {
        xxx: xxx
    }
}
{
    status: 200,
    time: 000000000000,
    data: {
        xxx: xxx
    }
}

在 API 文档中,为了方便编写,所有的返回数据只会写 data 的内容,不会写 status 与 time 。其次,所有的 API 均在 /api/ 目录下! 同时请注意,对于 data,错误时,有可能会返回国际化的内容,所以请不要在 data 本身就是字符串时,通过 data 判断错误返回!但是所有成功请求返回都为 "OK",应判断正确返回而不是判断错误返回

以 Apache License 2.0 协议开源