docs(api): 完善API文档格式,为每个接口添加中文标题和代码块

为提升文档可读性,将API接口的标题改为中文描述并在下方添加代码块格式的HTTP方法及路径。
修改涉及公共API和管理员API两部分文档。
This commit is contained in:
anghunk
2026-01-21 11:59:33 +08:00
parent 430ef6d79d
commit 97d927edce
2 changed files with 65 additions and 13 deletions

View File

@@ -4,7 +4,11 @@
包含路径、方法、参数、请求体和响应示例。
## GET /api/comments
## 获取指定文章的评论列表
```
GET /api/comments
```
获取指定文章的评论列表。
@@ -91,7 +95,11 @@
}
```
## POST /api/comments
## 提交新评论或回复
```
POST /api/comments
```
提交新评论或回复。
@@ -220,7 +228,11 @@
}
```
## GET /api/config/comments
## 获取评论相关的公开配置
```
GET /api/config/comments
```
获取评论相关的公开配置,用于前端组件读取博主邮箱、徽标等信息。