Files

anghunk 4a674ee17a docs: 重构API文档结构，合并子页面到主文档

将分散的API子页面内容合并到对应的主文档中，简化文档结构。具体合并内容包括：
- 将 verify-admin.md 内容合并到 auth.md
- 将 track-visit.md 内容合并到 analytics.md
- 将 get-config.md 内容合并到 config.md
- 将 get-comments.md、post-comment.md、like-comment.md 内容合并到 comments.md
- 将 get-like-status.md、post-like.md 内容合并到 like.md

删除原有的独立子页面文件，使API文档更加集中和易于维护。

2026-02-06 19:37:26 +08:00

3.7 KiB

Raw Blame History

点赞接口

文章和评论点赞相关的公开接口。

获取点赞状态

GET /api/like

获取当前页面的点赞状态和总点赞数，一般由前端组件在页面加载时自动调用。

方法：GET
路径：/api/like
鉴权：不需要

查询参数

名称	位置	类型	必填	说明
`post_slug`	query	string	是	页面唯一标识符，`window.location.origin + window.location.pathname`

请求头（可选）

名称	必填	示例	说明
`X-CWD-Like-User`	否	`550e8400-e29b-41d4-a716...`	前端生成的匿名用户标识，用于区分不同用户

未显式传入 X-CWD-Like-User 时，服务端会尝试使用 cf-connecting-ip 作为用户标识，找不到时退回到 anonymous。

成功响应

状态码：200

{
  "liked": false,
  "alreadyLiked": false,
  "totalLikes": 12
}

字段说明：

字段名	类型	说明
`liked`	boolean	当前用户是否已点赞
`alreadyLiked`	boolean	预留字段，当前实现始终为 `false`
`totalLikes`	number	当前页面的总点赞数

错误响应

缺少 post_slug：

状态码：400

{
  "message": "post_slug is required"
}

服务器内部错误：

状态码：500

{
  "message": "获取点赞状态失败"
}

点赞文章

POST /api/like

对当前页面执行点赞操作，同一用户对同一页面只会计入一次点赞。

方法：POST
路径：/api/like
鉴权：不需要

请求头

名称	必填	示例	说明
`ContentC-Type`	是	`application/json`
`X-CWD-Like-User`	否	`550e8400-e29b-41d4-a716...`	前端生成的匿名用户标识，用于区分不同用户

请求体

{
  "postSlug": "https://example.com/blog/hello-world",
  "postTitle": "博客标题，可选",
  "postUrl": "https://example.com/blog/hello-world"
}