feat(analytics): 扩展页面访问统计接口并新增站点隔离文档
- 在 `/admin/analytics/pages` 接口响应中添加 `itemsByPv` 和 `itemsByLatest` 字段,分别返回按访问量和最新访问排序的前20条数据,优化前端数据展示逻辑 - 前端管理后台适配新的接口响应结构,提升页面访问统计页面的性能和用户体验 - 新增站点隔离配置文档 (`/docs/config/site-isolation.md`),说明如何通过 `siteId` 配置实现数据隔离 - 在前端配置指南中补充 `siteId` 配置示例 - 新增常见问题文档 (`/docs/common-problems.md`),解答设置 `siteId` 后评论数据不显示的问题及数据迁移方案 - 在导航栏和侧边栏添加“常见问题”和“配置”相关入口,完善文档结构 - 修复前端组件 API 调用中 `postSlug` 参数可能为 `postUrl` 的兼容性问题
This commit is contained in:
@@ -2,5 +2,6 @@ export default [
|
||||
{ text: '首页', link: '/' },
|
||||
{ text: '快速开始', link: '/guide/getting-started' },
|
||||
{ text: 'API 文档', link: '/api/overview' },
|
||||
{ text: '常见问题', link: '/common-problems' },
|
||||
{ text: '管理后台', link: 'https://cwd.zishu.me' },
|
||||
];
|
||||
|
||||
@@ -20,7 +20,14 @@ export const rootSidebar = [
|
||||
{ text: '数据管理', link: '/function/data-migration' },
|
||||
],
|
||||
},
|
||||
{
|
||||
text: '配置',
|
||||
items: [
|
||||
{ text: '站点隔离', link: '/config/site-isolation' },
|
||||
],
|
||||
},
|
||||
{ text: '反馈', link: '/guide/feedback' },
|
||||
{ text: '常见问题', link: '/common-problems' },
|
||||
];
|
||||
|
||||
export const apiSidebar = [
|
||||
|
||||
@@ -124,13 +124,24 @@ GET /admin/analytics/pages
|
||||
"postUrl": "https://example.com/blog/hello-world",
|
||||
"pv": 100,
|
||||
"lastVisitAt": 1737593600000
|
||||
},
|
||||
}
|
||||
],
|
||||
"itemsByPv": [
|
||||
{
|
||||
"postSlug": "https://example.com/about",
|
||||
"postTitle": "关于我",
|
||||
"postUrl": "https://example.com/about",
|
||||
"pv": 50,
|
||||
"lastVisitAt": 1737593500000
|
||||
"postSlug": "https://example.com/blog/hello-world",
|
||||
"postTitle": "Hello World",
|
||||
"postUrl": "https://example.com/blog/hello-world",
|
||||
"pv": 100,
|
||||
"lastVisitAt": 1737593600000
|
||||
}
|
||||
],
|
||||
"itemsByLatest": [
|
||||
{
|
||||
"postSlug": "https://example.com/blog/hello-world",
|
||||
"postTitle": "Hello World",
|
||||
"postUrl": "https://example.com/blog/hello-world",
|
||||
"pv": 100,
|
||||
"lastVisitAt": 1737593600000
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -138,13 +149,16 @@ GET /admin/analytics/pages
|
||||
|
||||
字段说明:
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
| ------------- | ------ | -------------------------- |
|
||||
| `postSlug` | string | 文章唯一标识符 |
|
||||
| `postTitle` | string \| null | 文章标题 |
|
||||
| `postUrl` | string \| null | 文章 URL |
|
||||
| `pv` | number | 访问量(PV) |
|
||||
| `lastVisitAt` | number \| null | 最后访问时间戳(毫秒) |
|
||||
| 字段名 | 类型 | 说明 |
|
||||
| ------------------- | ------ | ----------------------------------------- |
|
||||
| `items` | Array | 根据 `order` 参数返回的主列表 |
|
||||
| `itemsByPv` | Array | 按 `order=pv` 规则排序后的前 20 条数据 |
|
||||
| `itemsByLatest` | Array | 按 `order=latest` 规则排序后的前 20 条数据 |
|
||||
| `postSlug` | string | 文章唯一标识符 |
|
||||
| `postTitle` | string \| null | 文章标题 |
|
||||
| `postUrl` | string \| null | 文章 URL |
|
||||
| `pv` | number | 访问量(PV) |
|
||||
| `lastVisitAt` | number \| null | 最后访问时间戳(毫秒) |
|
||||
|
||||
**错误响应**
|
||||
|
||||
|
||||
16
docs/common-problems.md
Normal file
16
docs/common-problems.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# 常见问题
|
||||
|
||||
## 1. 为什么设置完 siteId 后,评论区没有显示评论数据?
|
||||
|
||||
因为设置了 siteId 后,接口会根据 siteId 来查询数据库带有你设置的 siteId 的评论数据。所以如果设置了 siteId,旧数据就有可能不显示,需要手动去 Cloudflare D1 控制台 Query 运行 SQL 语句来更新数据。
|
||||
|
||||
- `abc`: 你要设置的 siteId
|
||||
- `example.com`: 查找包含指定域名的评论数据
|
||||
|
||||
```sql
|
||||
UPDATE Comment
|
||||
SET site_id = 'abc'
|
||||
WHERE post_url LIKE '%example.com%';
|
||||
```
|
||||
|
||||
运行以上 SQL 语句后,评论区就会显示带有 `abc` siteId 的评论数据了。
|
||||
9
docs/config/site-isolation.md
Normal file
9
docs/config/site-isolation.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# 站点隔离
|
||||
|
||||
配置支持站点数据隔离。
|
||||
|
||||
通过前端实例调用时进行配置:
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
@@ -28,6 +28,7 @@ CWD 评论组件采用 **Shadow DOM** 技术构建,基于独立根节点渲染
|
||||
const comments = new CWDComments({
|
||||
el: '#comments',
|
||||
apiBaseUrl: 'https://your-api.example.com', // 换成你的 API 地址
|
||||
siteId: 'your-site-id', // 换成你的站点 ID(关键词),比如 blog
|
||||
});
|
||||
comments.mount();
|
||||
</script>
|
||||
|
||||
@@ -14,6 +14,9 @@ hero:
|
||||
- theme: alt
|
||||
text: Github
|
||||
link: https://github.com/anghunk/cwd
|
||||
- theme: alt
|
||||
text: 常见问题
|
||||
link: /common-problems
|
||||
|
||||
features:
|
||||
- icon: ⚡️
|
||||
|
||||
@@ -128,7 +128,7 @@ export function createApiClient(config) {
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
body: JSON.stringify({
|
||||
postSlug: config.postSlug,
|
||||
postSlug: config.postUrl || config.postSlug,
|
||||
postTitle: config.postTitle,
|
||||
postUrl: config.postUrl
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user