From a698734df5012d81c8a3c6d069be2ffc4f145933 Mon Sep 17 00:00:00 2001 From: anghunk Date: Mon, 9 Feb 2026 16:40:42 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E4=BB=A5=E5=8F=8D=E6=98=A0=E4=BB=8E=E5=9F=9F=E5=90=8D=E5=88=B0?= =?UTF-8?q?=E7=AB=99=E7=82=B9=E7=9A=84=E6=9C=AF=E8=AF=AD=E5=8F=98=E6=9B=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 将“域名筛选”统一更新为“站点筛选”或“多站点管理” - 更新管理后台API文档，明确支持通过siteId参数筛选数据 - 在站点隔离配置文档中新增管理后台API使用说明 - 更新数据统计文档，将按域名分类改为按站点分类 - 修正相关API参数说明，从domain参数改为siteId参数 --- docs/api/admin/comments.md | 2 +- docs/api/admin/data-migration.md | 24 +++++++++++++++++++++- docs/api/admin/stats.md | 14 ++++++------- docs/config/site-isolation.md | 34 ++++++++++++++++++++++++++++++++ docs/function/admin-panel.md | 4 ++-- docs/function/data-statistics.md | 8 ++++---- 6 files changed, 71 insertions(+), 15 deletions(-) diff --git a/docs/api/admin/comments.md b/docs/api/admin/comments.md index 8f76c0c..bc9e7b1 100644 --- a/docs/api/admin/comments.md +++ b/docs/api/admin/comments.md @@ -30,7 +30,7 @@ GET /admin/comments/list 说明： - 当前实现中每页固定大小为 `10`，暂不支持 `pageSize` 或状态过滤； -- 当提供 `domain` 参数时，会匹配该域名下的评论，例如 `https://example.com/...`、`http://example.com/...`。 +- 当提供 `siteId` 参数且不为 `default` 时，仅返回该站点下的评论。 **成功响应** diff --git a/docs/api/admin/data-migration.md b/docs/api/admin/data-migration.md index cebffdf..daa46d7 100644 --- a/docs/api/admin/data-migration.md +++ b/docs/api/admin/data-migration.md @@ -14,12 +14,23 @@ Authorization: Bearer GET /admin/comments/export ``` -导出所有评论数据，返回格式为 JSON，字段与数据库结构一致。 +导出评论数据，返回格式为 JSON，字段与数据库结构一致。 - 方法：`GET` - 路径：`/admin/comments/export` - 鉴权：需要（Bearer Token） +**查询参数** + +| 名称 | 位置 | 类型 | 必填 | 说明 | +| -------- | ----- | ------ | ---- | ------------------------------- | +| `siteId` | query | string | 否 | 按站点 ID 筛选导出的评论数据，如 `blog`、`docs` | + +说明： + +- 当提供 `siteId` 参数且不为 `default` 时，仅导出该站点下的评论数据 +- 不提供 `siteId` 参数时，导出所有评论数据 + **成功响应** - 状态码：`200` @@ -249,6 +260,17 @@ GET /admin/export/stats - 路径：`/admin/export/stats` - 鉴权：需要（Bearer Token） +**查询参数** + +| 名称 | 位置 | 类型 | 必填 | 说明 | +| -------- | ----- | ------ | ---- | ------------------------------- | +| `siteId` | query | string | 否 | 按站点 ID 筛选导出的统计数据，如 `blog`、`docs` | + +说明： + +- 当提供 `siteId` 参数且不为 `default` 时，仅导出该站点下的统计数据（包括页面访问汇总、按日访问明细以及点赞明细） +- 不提供 `siteId` 参数时，导出所有站点的统计数据 + **成功响应** - 状态码：`200` diff --git a/docs/api/admin/stats.md b/docs/api/admin/stats.md index 4d48c55..a3a94c2 100644 --- a/docs/api/admin/stats.md +++ b/docs/api/admin/stats.md @@ -1,6 +1,6 @@ # 统计数据 -统计数据接口用于获取评论统计、域名列表等数据看板相关信息。 +统计数据接口用于获取评论统计、站点列表等数据看板相关信息。 所有接口都需要在请求头中携带 Bearer Token。 @@ -80,12 +80,12 @@ GET /admin/stats/comments | `summary.approved` | number | 已通过评论数 | | `summary.pending` | number | 待审核评论数 | | `summary.rejected` | number | 已拒绝评论数 | -| `domains` | Array\ | 按域名聚合的评论统计列表 | -| `domains[].domain` | string | 解析后的域名（如 `example.com`） | -| `domains[].total` | number | 该域名下评论总数 | -| `domains[].approved` | number | 该域名下已通过评论数 | -| `domains[].pending` | number | 该域名下待审核评论数 | -| `domains[].rejected` | number | 该域名下已拒绝评论数 | +| `domains` | Array\ | 按站点聚合的评论统计列表 | +| `domains[].domain` | string | 站点 ID（如 `blog`、`docs` 或 `default`） | +| `domains[].total` | number | 该站点下评论总数 | +| `domains[].approved` | number | 该站点下已通过评论数 | +| `domains[].pending` | number | 该站点下待审核评论数 | +| `domains[].rejected` | number | 该站点下已拒绝评论数 | | `last7Days` | Array\ | 最近 30 天的每日评论数（按自然日聚合） | | `last7Days[].date` | string (YYYY-MM-DD) | 日期，UTC 时间格式化后的自然日 | | `last7Days[].total` | number | 当日评论总数 | diff --git a/docs/config/site-isolation.md b/docs/config/site-isolation.md index 36da018..ce63b24 100644 --- a/docs/config/site-isolation.md +++ b/docs/config/site-isolation.md @@ -39,6 +39,8 @@ CWD 评论系统支持通过 `siteId` 参数实现多站点数据隔离。当你 ## API 调用 +### 公开 API + 当使用站点隔离功能时，所有公开 API 请求都需要在查询参数中携带 `siteId`： ```javascript @@ -59,6 +61,38 @@ POST /api/comments GET /api/config/comments?siteId=blog ``` +### 管理后台 API + +管理后台同样支持通过 `siteId` 参数进行数据筛选： + +```javascript +// 获取评论列表 +GET /admin/comments/list?siteId=blog + +// 导出评论数据 +GET /admin/comments/export?siteId=blog + +// 获取评论统计数据 +GET /admin/stats/comments?siteId=blog + +// 获取访问统计概览 +GET /admin/analytics/overview?siteId=blog + +// 获取页面访问统计 +GET /admin/analytics/pages?siteId=blog + +// 获取点赞统计数据 +GET /admin/likes/stats?siteId=blog + +// 导出统计数据 +GET /admin/export/stats?siteId=blog +``` + +说明： + +- 当提供 `siteId` 参数且不为 `default` 时，接口仅返回该站点下的数据 +- 不提供 `siteId` 参数时，返回所有站点的数据 + ## 多站点示例 如果你有多个站点，可以为每个站点配置不同的 `siteId`： diff --git a/docs/function/admin-panel.md b/docs/function/admin-panel.md index 1fa508c..1c32696 100644 --- a/docs/function/admin-panel.md +++ b/docs/function/admin-panel.md @@ -2,9 +2,9 @@ 管理后台用于审核评论、删除评论和管理评论设置。 -## 域名筛选（多站点管理） +## 多站点管理 -管理后台顶部导航栏提供了全局域名下拉选择器，用于在多域名站点之间切换数据视图。 +管理后台顶部导航栏提供了站点下拉选择器，用于在多站点之间切换数据视图。 ## 设置 diff --git a/docs/function/data-statistics.md b/docs/function/data-statistics.md index c07c9e2..afedeef 100644 --- a/docs/function/data-statistics.md +++ b/docs/function/data-statistics.md @@ -8,7 +8,7 @@ CWD 内置提供评论数据分析和访客数据分析功能。 - 总评论数统计 - 最近 30 天评论数据可视化图表 -- 按域名分类查看评论数据 +- 按站点分类查看评论数据 ## 访客数据分析 @@ -36,8 +36,8 @@ CWD 内置提供评论数据分析和访客数据分析功能。 - 同比趋势：对比本周与上周、本月与上月的访问量变化 - 趋势图表：通过可视化图表直观展示访问数据的变化趋势 -## 域名筛选 +## 站点筛选 -管理后台顶部导航栏提供了全局域名下拉选择器，用于在多域名站点之间切换数据视图。 +管理后台顶部导航栏提供了全局站点下拉选择器，用于在多站点之间切换数据视图。 -在数据看板页面，所有数据统计都会根据选中的域名进行筛选，确保您能准确查看每个站点的数据情况。 +在数据看板页面，所有数据统计都会根据选中的站点进行筛选，确保您能准确查看每个站点的数据情况。