友链列表接口
接口说明
获取所有友链信息。返回友链的基本信息和所属分类。
- 接口URL:
/api/friends/index
- 请求方法:
POST
- 权限要求: 无需登录即可访问
请求参数
此接口无需请求参数。
响应结构
typescript
interface Response {
code: number; // 状态码
message: string; // 响应消息
data?: {
list: Array<{
friend_id: number; // 友链ID
friend_name: string; // 友链名称
friend_url: string; // 友链地址
friend_avatar: string; // 友链头像
friend_desc: string; // 友链描述
friend_coll_id: number; // 分类ID
frd_coll_name: string; // 分类名称
frd_coll_path: string; // 分类路径
}>;
total: number; // 总条数
};
}
响应示例
json
{
"code": 0,
"message": "success",
"data": {
"list": [
{
"friend_id": 1,
"friend_name": "示例博客",
"friend_url": "https://example.com",
"friend_avatar": "https://example.com/avatar.jpg",
"friend_desc": "一个示例博客",
"friend_coll_id": 1,
"frd_coll_name": "技术博客",
"frd_coll_path": "tech"
}
],
"total": 1
}
}
特殊说明
数据排序
- 返回的友链按照ID升序排列
- 同一分类下的友链会被分组在一起
友链信息
- 友链头像支持多种图片格式
- 友链描述可能为空
错误码说明
错误码 | 说明 | 处理建议 |
---|---|---|
0 | 成功 | - |
500 | 服务器错误 | 请联系管理员 |
调用示例
typescript
const response = await fetch('/api/friends/index', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
}
});
const result = await response.json();
if (result.code === 0) {
// 获取成功,显示友链列表
console.log('友链列表:', result.data.list);
console.log('友链总数:', result.data.total);
} else {
// 获取失败,显示错误信息
console.error(result.message);
}