Skip to content

Commit bccd6ef

Browse files
committed
docs: 同步 mx-core API 端点至 v3
将部署、使用、迁移相关文档中的 /api/v2 更新为 /api/v3,与 mx-core API_VERSION=3 一致。v11→v12 升级说明补充 API 路径变更 与旧主题(yun/kami/shiro)兼容性说明。
1 parent 94b4735 commit bccd6ef

9 files changed

Lines changed: 13 additions & 12 deletions

File tree

content/docs/deploy/agent.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Agent 会依次执行以下操作:
126126

127127
```
128128
请帮我验证:
129-
1. 访问 https://example.com/api/v2/ping 是否返回 pong
129+
1. 访问 https://example.com/api/v3/ping 是否返回 pong
130130
2. 访问 https://example.com/proxy/qaqdmin 是否能打开后台
131131
3. 检查 Docker 容器状态是否全部 healthy
132132
```

content/docs/deploy/docker.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ docker compose up -d
124124
启动后,请按以下清单确认服务正常:
125125

126126
- [ ] `docker compose ps` 显示所有服务状态为 healthy
127-
- [ ] `curl http://localhost:2333/api/v2/ping` 返回 `pong`
127+
- [ ] `curl http://localhost:2333/api/v3/ping` 返回 `pong`
128128
- [ ] 浏览器能打开后台初始化页面 `http://你的域名/proxy/qaqdmin`
129129

130130
## 下一步

content/docs/deploy/reverse-proxy.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ server {
115115

116116
<Callout type="info">
117117
使用双域名配置时:
118-
- API 地址为 `https://server.example.com/api/v2`
118+
- API 地址为 `https://server.example.com/api/v3`
119119
- 前端地址为 `https://www.example.com`
120120
- Gateway 为 `https://server.example.com`
121121
- 后台为 `https://server.example.com/proxy/qaqdmin`
@@ -145,8 +145,8 @@ server {
145145
proxy_pass http://127.0.0.1:2333/socket.io;
146146
}
147147
148-
location /api/v2 {
149-
proxy_pass http://127.0.0.1:2333/api/v2;
148+
location /api/v3 {
149+
proxy_pass http://127.0.0.1:2333/api/v3;
150150
}
151151
152152
location /render {
@@ -174,7 +174,7 @@ server {
174174

175175
<Callout type="info">
176176
使用单域名配置时:
177-
- API 地址为 `https://www.example.com/api/v2`
177+
- API 地址为 `https://www.example.com/api/v3`
178178
- 前端地址为 `https://www.example.com`
179179
- Gateway 为 `https://www.example.com`
180180
- 后台为 `https://www.example.com/proxy/qaqdmin`

content/docs/getting-started/quick-start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ import { Step, Steps } from 'fumadocs-ui/components/steps'
5656
<Step title="验证运行状态">
5757
确认以下事项均正常:
5858

59-
- [ ] 后端 API 响应正常(访问 `http://localhost:2333/api/v2` 能返回 JSON)
59+
- [ ] 后端 API 响应正常(访问 `http://localhost:2333/api/v3` 能返回 JSON)
6060
- [ ] 后台管理页面能正常加载和登录
6161
- [ ] 可以在后台发布一篇文章并保存成功
6262
</Step>

content/docs/migrate/from-wordpress.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ WordPress 文章中的图片通常存放在 `wp-content/uploads/` 目录。迁
102102

103103
```sql
104104
-- 在数据库中批量替换图片链接(请先备份!)
105-
UPDATE posts SET text = REPLACE(text, 'old-domain.com/wp-content/uploads', 'new-domain.com/api/v2/static/image');
105+
UPDATE posts SET text = REPLACE(text, 'old-domain.com/wp-content/uploads', 'new-domain.com/api/v3/static/image');
106106
```
107107
</Step>
108108

content/docs/migrate/v11-to-v12.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,13 @@ v12 是一次**重大版本升级**,底层数据库从 MongoDB 更换为 Postg
2020
- **数据库**:MongoDB → PostgreSQL(性能更好,数据关系更安全)
2121
- **备份方式**:以后用 `pg_dump` 代替 `mongodump`
2222
- **环境变量**:旧的 `DB_HOST``MONGO_CONNECTION` 等变量失效
23+
- **API 路径**`/api/v2``/api/v3`(响应结构亦有调整,详见下文)
2324

2425
### 什么不会变?
2526

26-
- 前端页面、API 接口和之前完全一致
2727
- 你的文章、评论、图片、配置全部保留
2828
- 登录方式、密码、API Key 不受影响
29+
- 已适配 v3 的前端(如 yohaku)可直接对接;旧主题(yun/kami/shiro)已不再维护,建议迁至 yohaku
2930

3031
### 我需要停站多久?
3132

content/docs/use/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Mix Space 支持 **Markdown** 和 **Lexical 富文本**两种编辑格式。可
5555

5656
### 上传的图片 URL 格式是什么?
5757

58-
- 本地存储:`/api/v2/static/{type}/{filename}`
58+
- 本地存储:`/api/v3/static/{type}/{filename}`
5959
- S3 存储:`{自定义域名}/{前缀}/{filename}`
6060

6161
自定义命名规则可以在「设定 → 文件上传设定」中配置。

content/docs/use/serverless.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Function 类型支持安装 npm 依赖包。在管理页面中:
118118

119119
| 访问方式 | URL 格式 |
120120
|----------|----------|
121-
| 按名称和分组 | `/api/v2/snippets/{reference}/{name}` |
121+
| 按名称和分组 | `/api/v3/snippets/{reference}/{name}` |
122122
| 按自定义路径 | `/s/{customPath}`(需要设置自定义路径) |
123123

124124
- **公开(Public)** Snippet 所有人可访问

content/docs/use/writing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Mix Space 提供了多种写作方式,无论你习惯在浏览器中编辑,
5555
### 配置 API
5656

5757
在插件设置中填入:
58-
- **API Endpoint**:你的 Mix Space 地址,如 `https://example.com/api/v2`
58+
- **API Endpoint**:你的 Mix Space 地址,如 `https://example.com/api/v3`
5959
- **Token**:在 Mix Space 后台「设定 → 安全 → API Token」中生成
6060
</Step>
6161

0 commit comments

Comments
 (0)