接口说明
接口 URL
https://maxpcimg.online/api/v1
验证方式
当前版本接口采用 「HTTP 基本验证」的方式验证授权，从个人中心获取到 token 后，通过设置请求 header 标头来验证请求(Bearer Token)，例如：
"Authorization": "Bearer 1|1bJbwlqBfnggmOMEZqXT5XusaIwqiZjCDs7r1Ob5"
如果未设置 Authorization 的情况下请求上传接口，将会被视为游客上传。
公共请求 headers 说明
| 字段 | 类型 | 说明 |
|---|---|---|
| Authorization | String | 授权 Token，例如：Bearer 1|1bJbwlqBfnggmOMEZqXT5XusaIwqiZjCDs7r1Ob5 |
| Accept | String | 必须设置为 application/json |
响应状态码
| 状态码 | 说明 |
|---|---|
| 401 | 未登录或授权失败 |
| 403 | 管理员关闭了接口功能或没有该接口权限 |
| 429 | 超出请求配额，请求受限 |
| 500 | 服务端出现异常 |
文档中接口的请求参数，使用红色「*」符号标注，则表示为必传项。
用户相关
用户资料
GET/profile
返回参数
| 字段 | 类型 | 说明 |
|---|---|---|
| status | Boolean | 状态，true 或 false |
| message | String | 描述信息 |
| data | Object | 数据 |
| username | String | 用户名 |
| name | String | 昵称 |
| avatar | String | 头像地址 |
| capacity | Float | 总容量 |
| size | Float | 已使用容量 |
| image_num | Integer | 图片数量 |
| album_num | Integer | 相册数量 |
{
"status": true,
"message": "成功获取用户资料",
"data": {
"username": "user123",
"name": "张三",
"avatar": "https://example.com/avatars/user123.jpg",
"email": "[email protected]",
"capacity": 1024,
"size": 256.5,
"url": "https://example.com/users/user123",
"image_num": 42,
"album_num": 5,
"registered_ip": "192.168.1.1"
}
}
策略相关
策略列表
GET/strategies
请求参数 (Query)
| 字段 | 类型 | 说明 |
|---|---|---|
| q | String | 筛选关键字 |
返回参数
| 字段 | 类型 | 说明 |
|---|---|---|
| status | Boolean | 状态，true 或 false |
| message | String | 描述信息 |
| data | Object | 数据 |
| strategies | Object[] | 策略数据 |
| id | Integer | 策略 ID |
| name | String | 策略名称 |
{
"status": true,
"message": "成功获取策略列表",
"data": {
"strategies": [
{
"id": 1,
"name": "本地储存"
},
{
"id": 2,
"name": "阿里云OSS"
},
{
"id": 3,
"name": "腾讯云COS"
}
]
}
}
图片相关
生成临时上传 Token
POST/images/tokens
请求参数 (Body)
| 字段 | 类型 | 说明 |
|---|---|---|
| num | Integer | 生成数量，最大 100 |
| seconds | Integer | 有效期(秒)，最大 2626560 (一个月) |
{
"status": true,
"message": "成功生成临时上传 Token",
"data": {
"tokens": [
{
"token": "xG8bZn7R2ysJdQEK",
"expired_at": "2023-06-01 12:00:00"
},
{
"token": "uY7aLp9H1xvFcSWD",
"expired_at": "2023-06-01 12:00:00"
}
]
}
}
上传图片
POST/upload
请求参数 (Body)
| 字段 | 类型 | 说明 |
|---|---|---|
| file | File | 图片文件 |
| token | String | 临时上传 Token |
| permission | Integer | 权限，1=公开，0=私有 |
| strategy_id | Integer | 储存策略ID |
| album_id | Integer | 相册ID |
删除图片
DELETE/images/:key
请求参数 (Params)
| 字段 | 类型 | 说明 |
|---|---|---|
| key | String | 图片密钥 |
{
"status": true,
"message": "图片删除成功",
"data": {}
}
相册相关
相册列表
GET/albums
请求参数 (Query)
| 字段 | 类型 | 说明 |
|---|---|---|
| page | Integer | 页码 |
| order | String | 排序方式，newest=最新，earliest=最早，most=图片最多，least=图片最少 |
| q | String | 筛选关键字 |
删除相册
DELETE/albums/:id
请求参数 (Params)
| 字段 | 类型 | 说明 |
|---|---|---|
| id | String | 相册自增 ID |
{
"status": true,
"message": "相册删除成功",
"data": {}
}