Hexo-Circle-of-Friends

/all

描述:获取数据库中的统计信息和文章信息列表。支持分页(start、end)和排序(rule),可用于前端展示朋友圈完整数据。

请求方式:GET

请求参数说明:

参数名 类型 位置 默认值 说明
start integer query 0 起始位置(从 0 开始计数)。
end integer query -1 结束位置,-1 表示不限制(返回全部)。
rule string query updated 排序规则,可选:created(按创建时间)/ updated(按更新时间)。

注意:start ≥ 0;rule 仅允许 created 或 updated,否则返回 400 错误。

/friend

描述:从数据库中获取所有友链信息,返回包含名称、链接和头像的完整列表。

请求方式:GET

请求参数说明:无参数。

/randomfriend

描述:从数据库中随机返回指定数量的友链信息,支持批量返回。

请求方式:GET

请求参数说明:

参数名 类型 位置 必填 说明 默认值 最小值 最大值
num integer query 返回的友链数量 1 1 100

/randompost

描述:从文章库中随机返回指定数量的文章信息,可用于友链朋友圈的「随机文章推荐」。

请求方式:GET

请求参数说明:

参数名 类型 位置 必填 说明 默认值 最小值 最大值
num integer query 返回的文章数量 1 1 100

/version

描述:返回当前 API 服务的版本号。

请求方式:GET

请求参数说明:无参数。

/post

描述:根据朋友链接获取该朋友的所有文章,支持随机朋友或指定朋友,并可按时间规则排序。

请求方式:GET

请求参数说明:

参数名 类型 位置 必填 说明 默认值 取值范围
link string query 朋友链接地址,为空时随机选择 null 合法的 URL 或空
num integer query 返回文章数量,-1 表示全部 -1 -1 或 1 ~ ∞
rule string query 排序规则 created created 或 updated

/summary

描述:根据文章链接获取由 AI 生成的文章摘要信息。

请求方式:GET

请求参数说明:

参数名 类型 位置 必填 说明
link string query 文章链接地址