外观
开始使用
这一节是平台的入口教程:从零把环境跑起来,登录、建模、授权、写入,再到第一个工作流、第一张矢量瓦片和第一个 WebSocket 订阅。全部命令都对照当前代码核实过,跟着做就能做通,做完也能明白每一步背后发生了什么。先读快速开始拿到一个可用的本地栈,再按角色选路线深入。
学习路线(按角色)
评估者:30 分钟判断要不要用
应用开发者:跑通一条业务链路
- 快速开始:准备本地栈与自举管理员;
- 第一次调用:动态建模与 fail-closed 授权体验;
- 第一个工作流:内置模板、流程 DSL、人工任务与补偿;
- 第一个矢量瓦片:图层、要素发布到 z/x/y 瓦片;
- REST API 总览:北向接口全景。
平台开发者:进入代码
- 本地开发工作流:cargo 命令、分进程运行与测试门控;
- WebSocket 订阅实战:网关 ws 面协议端到端;
- 架构总览:分层视角与请求生命周期入口;
- 源码地图:每个 crate 讲什么;
- 参与开发:环境、规约与 CI 门禁。
运维:部署与观测
本节内容
| 页面 | 内容 | 适合谁 |
|---|---|---|
| 快速开始 | Docker Compose 与源码双路径,15 分钟跑通全平台并自举管理员 | 所有人 |
| 环境与安装 | 工具链版本要求、Docker、PostgreSQL/PostGIS、可选工具 | 准备接入的开发者 |
| 本地开发工作流 | 日常 cargo 命令、分进程运行、live 测试门控、调试 | 平台开发者 |
| 第一次调用 | 从登录、建模、授权到写入、查询与计量的完整旅程 | 应用开发者 |
| 第一个工作流 | 内置流程模板、自定义 DSL、人工任务与失败补偿 | 应用开发者 |
| 第一个矢量瓦片 | 从建图层、导要素、发布配置到请求 z/x/y 瓦片 | 应用开发者 |
| WebSocket 订阅实战 | 登录拿令牌、ws 升级、订阅与 seq 断线语义 | 应用与平台开发者 |
两条运行路径怎么选
| Docker Compose 单机套件 | 源码运行(svc-all-in-one) | |
|---|---|---|
| 前置依赖 | Docker + docker compose 插件 | Rust 1.96 + 本地 PostgreSQL(带 PostGIS) |
| 首次耗时 | 镜像构建约 10 到 20 分钟(含全量 cargo release 编译) | 约 5 到 10 分钟(debug 构建) |
| 适合场景 | 体验、演示、集成验证 | 开发、调试、改代码 |
| 数据持久 | named volume pgdata 与 rustsvc-data | 自定义 AIO__DATA_DIR 目录 |
两条路径殊途同归:单进程 svc-all-in-one 内装配全部服务,对外只暴露网关的 HTTP 8080 与 WS 8082 两个端口,外部依赖只有一个 PostgreSQL。