用于普通用户的登录
/api/login/user
- Authorization: Basic secretKey
- Content-Type: application/json
POST
JSON
绝大多数为JSON,具体查阅微信相关
[
{
"id": "123456", // int
"username": "xxx", // String
// other user info
}
]
成功响应:
{
"code": "200",
"message": "请求成功",
"data": [
{
"token": "asd214" // String, return user token
}
]
}
失败响应:
{
"code": "", // int, fail code
"message": "", // String, corresponding fail message
"data": [] // empty
}
- 200:成功
- 400:请求参数异常
- 401:授权失败
- 500:系统异常
用于普通用户获取管理员身份的二重验证登录
/api/login/admin
- Authorization: Basic secretKey
- Content-Type: application/json
POST
JSON
管理员密码应为数字/字符数字混合,具体有待商榷
[
{
"password": "123456", // int
}
]
成功响应:
{
"code": "200",
"message": "验证成功",
"data": ""
}
失败响应:
{
"code": "", // fail code
"message": "", // corresponding fail message
"data": [] // empty
}
- 200:成功
- 400:请求参数异常
- 401:验证失败
- 500:系统异常
用于登录后获取数据库中用户相关信息
/api/login/info
- Content-Type: application/json
POST
JSON
[
{
"token": "123a45t6", // String
}
]
成功响应:
{
"code": "200",
"message": "查询成功",
"data": [{
"username": "",
"id": "",
// other info
}]
}
失败响应:
{
"code": "", // fail code
"message": "", // corresponding fail message
"data": [] // empty
}
- 200:成功
- 400:请求参数异常
- 401:验证失败
- 500:系统异常
用于管理员创建新的推文,包括文本内容和音频文件。
/api/tweet/add
- Content-Type: multipart/form-data
- Authorization: Bearer [管理员的访问令牌]
POST
无参数
在请求示例中,使用multipart/form-data
格式来同时上传新的文本文件和音频文件。管理员权限要求在请求头中使用有效的管理员访问令牌。
POST /api/tweet/add HTTP/1.1
Host: your-api-host.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Authorization: Bearer [管理员的访问令牌]
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="text_file"; filename="new_text_file.txt"
Content-Type: text/plain
[这里放置您的新文本文件内容]
------WebKitFormBoundary7MA4YWxkTrZu0gW
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="audio_file"; filename="new_audio_file.mp3"
Content-Type: audio/mpeg
[这里放置您的新音频文件内容]
------WebKitFormBoundary7MA4YWxkTrZu0gW--
成功响应:
{
"code": "200",
"message": "推文上传成功",
"data": [{
"tweet_id": "1a234d5" // String, new tweet's id
// other info
}]
}
失败响应:
{
"code": "400", // fail code
"message": "", // corresponding fail message
"data": [] // empty
}
- 200:成功
- 400:请求参数异常
- 401:未经授权的访问
- 500:系统异常
用于管理员删除指定的推文
/api/tweet/delete
- Content-Type: application/json
- Authorization: Bearer [管理员的访问令牌]
DELETE
JSON
管理员权限要求在请求头中使用有效的管理员访问令牌。
{
"tweet_id": "12345" // String, 要删除的推文的ID
}
成功响应
{
"code": "200",
"message": "推文删除成功",
"data": "" // 空数据
}
失败响应
{
"code": "400",
"message": "请求参数异常",
"data": [] // 空数组
}
- 200:成功 - 推文删除成功,要求管理员权限。
- 400:请求参数异常 - 请求中可能缺少必要参数或格式不正确。
- 401:授权失败 - 未经管理员权限授权的访问。
- 404:推文不存在 - 要删除的推文ID不存在。
- 500:系统异常 - 服务器内部错误。
用于管理员修改指定推文的文本内容和音频文件。
/api/tweet/update
- Content-Type: multipart/form-data
- Authorization: Bearer[管理员的访问令牌]
PUT
无参数
在请求示例中,使用multipart/form-data
格式来同时上传新的文本文件和音频文件。管理员权限要求在请求头中使用有效的管理员访问令牌。
PUT /api/tweet/update HTTP/1.1
Host: your-api-host.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Authorization: Bearer [管理员的访问令牌]
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="tweet_id"; value="1a234d5" // String, 要修改的推文的ID
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="text_file"; filename="updated_text_file.txt"
Content-Type: text/plain
[这里放置您的更新后的文本文件内容]
------WebKitFormBoundary7MA4YWxkTrZu0gW
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="audio_file"; filename="updated_audio_file.mp3"
Content-Type: audio/mpeg
[这里放置您的更新后的音频文件内容]
------WebKitFormBoundary7MA4YWxkTrZu0gW--
成功响应
{
"code": "200",
"message": "推文修改成功",
"data": {
"tweet_id": "1a234d5", // String, modified tweet's id
// other info
}
}
失败响应
{
"code": "400", // fail code
"message": "", // corresponding fail message
"data": [] // empty
}
- 200:成功 - 推文修改成功,要求管理员权限。
- 400:请求参数异常 - 请求中可能缺少必要参数或格式不正确。
- 401:未经授权的访问 - 仅管理员有权修改推文。
- 404:推文不存在 - 要修改的推文ID不存在。
- 500:系统异常 - 服务器内部错误。
用于获取推文列表,以便在小程序中显示推文的缩略图。
/api/tweet/list
- Content-Type: application/json
GET
无参数
成功响应:
{
"code": "200",
"message": "获取推文列表成功",
"data": [
{
"tweet_id": "1a234d5", // String, 推文的ID
"thumbnail_url": "https://example.com/thumbnail.jpg", // String, 缩略图的URL
"title": "推文标题", // String, 推文标题
// other info
},
{
"tweet_id": "2b345e6",
"thumbnail_url": "https://example.com/thumbnail2.jpg",
"title": "另一个推文标题",
// other info
},
// 可能还有更多推文
]
}
失败响应:
{
"code": "400", // fail code
"message": "请求参数异常",
"data": [] // 空数组
}
- 200:成功 - 获取推文列表成功。
- 400:请求参数异常 - 请求中可能缺少必要参数或格式不正确。
- 500:系统异常 - 服务器内部错误。
用于获取指定推文的详细内容,以便在小程序中显示完整的推文。
/api/tweet/detail
- Content-Type: application/json
JSON
{
"tweet_id": "1a234d5" // String, 要查看的推文的ID
}
成功响应:
{
"code": "200",
"message": "获取推文详情成功",
"data": {
"tweet_id": "1a234d5", // String, 推文的ID
"title": "推文标题", // String, 推文标题
"content": "推文的详细内容...", // String, 推文内容
// other info
}
}
失败响应:
{
"code": "400", // fail code
"message": "请求参数异常",
"data": [] // 空数组
}
- 200:成功 - 获取推文详情成功。
- 400:请求参数异常 - 请求中可能缺少必要参数或格式不正确。
- 404:推文不存在 - 要查看的推文ID不存在。
- 500:系统异常 - 服务器内部错误。