内部接口
本部分向你介绍项目所使用的内部接口
接口基准地址
http://localhost:5678/api
身份认证
在 Header 中添加 Authorization
字段,值为 Bearer {Token}
关于如何获取 Token
详见登录认证接口 详见此处
响应状态码说明
状态码 | 含义 | 说明 |
---|---|---|
200 | OK | 请求成功 |
400 | BAD REQUEST | 请求的地址不存在或者包含不支持的参数 |
401 | UNAUTHORIZED | 未提供授权信息 |
403 | FORBIDDEN | 认证失败 |
500 | INTERNAL SERVER ERROR | 内部错误 |
返回内容格式
数据返回格式统一使用 JSON
名称 | 类型 | 描述 |
---|---|---|
code | number<0 | 1> | 业务代码,详见下方 |
message | string | 消息 |
type | string | 类型 |
result | boolean | object | string | 结果(不一定有) |
业务代码说明
状态码 | 说明 |
---|---|
0 | 请求失败 |
1 | 请求成功 |
参数传递
除 GET 请求通过 URL 传递参数外,其它请求方式均通过 Body 传递参数
接口类别
🗃️ User 用户
3 个项目
🗃️ File 文件系统
11 个项目
🗃️ Env 环境变量
6 个项目
🗃️ Cron 定时任务
9 个项目
🗃️ Message 消息中心
6 个项目
🗃️ 其它
2 个项目