# 参考文档

本目录包含 JRSoft Subway 协议的参考资料。

## 📚 文档列表

### [API 参考](./api.md)
完整的 API 文档：
- 接口定义
- 类型说明
- 方法签名
- 参数详解

### [术语表](./glossary.md)
项目中使用的专业术语：
- 协议术语
- 系统组件
- 技术概念
- 业务术语

### [常见问题](./faq.md)
常见问题解答：
- 协议相关
- 集成问题
- 性能优化
- 故障排查

## 🔍 快速查找

### API 分类

#### 消息类型
- [BaseMessage](./api.md#basemessage)
- [RegisterMessage](./api.md#registermessage)
- [CommandMessage](./api.md#commandmessage)
- [CommandResponseMessage](./api.md#commandresponsemessage)

#### 工具函数
- [createSimpleCommand](./api.md#createsimplecommand)
- [createBatchCommand](./api.md#createbatchcommand)
- [validateMessage](./api.md#validatemessage)

#### 类型守卫
- [isCommandMessage](./api.md#iscommandmessage)
- [isErrorMessage](./api.md#iserrormessage)

### 常用术语

- **Gateway** - 中心路由节点
- **Edge** - 设备代理节点
- **Device** - 终端设备
- **Command** - 控制命令
- **Batch** - 批量操作
- **Progress Update** - 进度更新

## 📖 使用方式

1. **API 查询** - 需要查找特定接口时，查看 [API 参考](./api.md)
2. **概念理解** - 遇到不熟悉的术语时，查看 [术语表](./glossary.md)
3. **问题解决** - 遇到常见问题时，查看 [FAQ](./faq.md)

## 🔗 外部链接

- [TypeScript 文档](https://www.typescriptlang.org/docs/)
- [WebSocket 规范](https://datatracker.ietf.org/doc/html/rfc6455)
- [JSON Schema](https://json-schema.org/)
- [ISO 8601 时间格式](https://en.wikipedia.org/wiki/ISO_8601)