Skip to content
风起 edited this page Mar 25, 2024 · 6 revisions

说明

此api提供给官方的webui使用,亦可以给其他途径使用,验证信息使用jwt-token的方式,默认浏览器登录会写入cookie,其他途径请自行报错。

api调用频率限制自行控制,api不提供版本兼容,每个发行版只支持最新的api,文档会保留旧版本api信息。

首页接口

搜索

预览HTML

快捷管理

用户相关

登录

使用用户名和密码等里

接口地址:/user/login

接口参数:

参数 类型 描述
username string 用户名或邮箱
password string 密码

接口返回:

错误代码 含义
0 正常
6 用户名或密码为空
9 用户不存在或用户密码错误

data json字段:

字段 类型 描述
jwt_token string jwt 认证信息

注册

后台

账户管理

仅管理员视角有效

获取用户列表

接口地址:/manager/user 请求方式:GET

接口参数:

参数 类型 描述
page int 页数

data json字段:

字段 类型 描述
id int 用户id
username string 用户名
email string 邮箱
password string 密码
created_at string 创建时间
updated_at string 最近修改时间

SingleFile

保存HTML

全局错误码列表

错误码 含义
0 一切正常
1 未知错误
2 邮箱格式错误
3 url格式错误
4 长度超过限制
5 参数不能为空
6 参数解析出错
7 用户名已存在
8 邮箱已存在
9 登录失败
10 登录态失效
11 记录不存在
12 数据已过期
13
14 服务器内部错误
15 用户已存在
16 登录态失效

概括

配置

接口

接口地址:Api 当前版本:

参与开发

Clone this wiki locally