开始之前¶
在正式接入前，建议先确认以下基础认知。
这是一个什么类型的文档站¶
这是一个纯展示型接口文档站，不提供：
- 登录
- 工作区
- 邮件验证
- 后台内容管理面板
它只解决一件事：把项目里的接口、推送协议和接入说明清楚地展示出来。
你会在这里看到哪些内容¶
- HTTP API
- WebSocket / WSS 推送
- 策略字段说明
- Redis 临时结构说明
- 采集命令与落库脚本
- 技术迁移说明
你不会在这里看到什么¶
- 多租户组织空间
- 在线编辑器
- 内部 Wiki 权限体系
- 邮箱登录流程
为什么这样设计¶
因为当前需求是“接口文档平台”，不是“团队知识库平台”。
对于纯接口说明场景，最重要的是：
- 打开即看
- 目录清楚
- 接口页统一
- 示例完整
- 搜索可用
推荐阅读顺序¶
- 快速开始
- 认证与签名
- 错误响应与状态码
- API 概述
- 具体接口页面