Skip to content

Commit 5418d3d

Browse files
committed
fix: 修复文档中的断链问题
- 修复endpoint/README.md中对api.md的引用,改为指向../api/reference.md - 修复api/README.md中引用不存在文件的链接 - 移除指向不存在模块文档的链接,改为说明性文字 - 更新相关文档链接,指向实际存在的文档
1 parent b1552ed commit 5418d3d

2 files changed

Lines changed: 28 additions & 35 deletions

File tree

versioned_docs/version-2.1.1/api/README.md

Lines changed: 27 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -13,40 +13,33 @@
1313

1414
FluxMQ 提供了丰富的 HTTP API 接口,涵盖以下功能模块:
1515

16-
### 核心功能
16+
### 核心文档
1717

18-
- [端点管理 API](./endpoint.md) - 动态管理 MQTT 端点
19-
- [连接管理 API](./connection.md) - 管理 MQTT 客户端连接
18+
- [完整 API 参考](./reference.md) - 所有 API 接口的完整文档
2019
- [消息发布 API](./Publish.md) - 通过 HTTP 发布 MQTT 消息
21-
- [主题管理 API](./topic.md) - 管理 MQTT 主题
22-
- [订阅管理 API](./subscribe.md) - 管理 MQTT 订阅
23-
24-
### 规则引擎
25-
26-
- [规则引擎 API](./rule.md) - 管理规则引擎规则
27-
- [数据源管理 API](./source.md) - 管理数据源配置
28-
29-
### 安全管理
30-
31-
- [认证管理 API](./auth.md) - 管理认证策略
32-
- [ACL 管理 API](./acl.md) - 管理访问控制列表
33-
34-
### 系统管理
35-
36-
- [系统管理 API](./system.md) - 系统配置和管理
37-
- [日志管理 API](./log.md) - 日志查询和管理
38-
- [监控 API](./monitor.md) - 系统监控和指标
39-
40-
### 扩展功能
41-
42-
- [脚本管理 API](./script.md) - 管理脚本
43-
- [指令管理 API](./command.md) - 管理指令配置
44-
- [扩展管理 API](./extension.md) - 管理扩展功能
45-
46-
### 数据管理
47-
48-
- [会话管理 API](./session.md) - 管理 MQTT 会话
49-
- [保留消息 API](./retain.md) - 管理保留消息
20+
- [连接检查 API](./Check.md) - 检查客户端连接状态
21+
- [连接踢出 API](./kick.md) - 踢出指定客户端连接
22+
23+
### API 功能分类
24+
25+
完整的 API 接口按功能分为以下模块,详细信息请查看 [完整 API 参考](./reference.md)
26+
27+
- **端点管理 API** - 动态管理 MQTT 端点
28+
- **连接管理 API** - 管理 MQTT 客户端连接
29+
- **主题管理 API** - 管理 MQTT 主题
30+
- **订阅管理 API** - 管理 MQTT 订阅
31+
- **规则引擎 API** - 管理规则引擎规则
32+
- **数据源管理 API** - 管理数据源配置
33+
- **认证管理 API** - 管理认证策略
34+
- **ACL 管理 API** - 管理访问控制列表
35+
- **系统管理 API** - 系统配置和管理
36+
- **日志管理 API** - 日志查询和管理
37+
- **监控 API** - 系统监控和指标
38+
- **脚本管理 API** - 管理脚本
39+
- **指令管理 API** - 管理指令配置
40+
- **扩展管理 API** - 管理扩展功能
41+
- **会话管理 API** - 管理 MQTT 会话
42+
- **保留消息 API** - 管理保留消息
5043

5144
## 通用说明
5245

@@ -186,7 +179,7 @@ def publish_message(topic, payload):
186179

187180
## 相关文档
188181

189-
- [配置指南](../config/README.md)
190-
- [安装部署](../install/README.md)
191182
- [快速开始](../README.md)
183+
- [端点管理](../endpoint/README.md)
184+
- [规则引擎](../gzyq/rule/README.md)
192185

versioned_docs/version-2.1.1/endpoint/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,6 @@ POST /api/endpoints/import
311311
## 相关文档
312312

313313
- [端点配置详解](config.md)
314-
- [API 参考](api.md)
314+
- [API 参考](../api/reference.md)
315315
- [监控指标](metrics.md)
316316
- [故障排查](troubleshooting.md)

0 commit comments

Comments
 (0)