接口说明:获取随机友链
基本信息
- 请求方式:
GET
- 请求路径:
/randomfriend
- 功能描述:从数据库中随机返回指定数量的友链信息,支持批量返回。
请求参数
参数名 | 类型 | 位置 | 必填 | 说明 | 默认值 | 最小值 | 最大值 |
---|---|---|---|---|---|---|---|
num | integer | query | 否 | 返回的友链数量 | 1 | 1 | 100 |
响应参数
成功响应 (200)
- 说明:成功返回随机友链。
- 返回格式:
application/json
- 示例(返回单个朋友):
json
[
{
"name": "白雾茫茫丶",
"link": "https://blog.xmwpro.com/",
"avatar": "https://cyan-blog.oss-cn-shenzhen.aliyuncs.com/global/avatar.jpg",
"error": true,
"createdAt": "2025-07-31 20:09:31"
}
]
失败响应
400 参数错误
- 说明:
num
参数非法或不在范围内。 - 示例:
json
{
"message": "param 'num' error"
}
404 未找到友链
- 说明:数据库中不存在友链记录。
- 示例:
json
{
"message": "not found"
}
422 验证错误
- 说明:请求参数验证失败。
- 示例:
json
{
"detail": [
{
"loc": ["string", 0],
"msg": "string",
"type": "string"
}
]
}
使用说明
- 可用于在前端展示「随机友链」或「友链推荐」功能。
- 参数
num
支持一次性返回多个友链(最多 100 个)。 - 若不传
num
,默认返回 1 条。