将调度内核标识从 SimpleLite 全面重命名为 Simple3。
配置段/环境变量、Launcher、健康检查 API、OpenAPI 与前后端文案同步；兼容探测旧 SimpleLite 进程名。 Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
黄兆尉
Cursor
+19
-19
@@ -1,19 +1,19 @@
|
||||
# SimpleLite 面向咪咕平台数据 API 文档
|
||||
# Simple3 面向咪咕平台数据 API 文档
|
||||
|
||||
> **版本**：与 SimpleLite 源码同步
|
||||
> **版本**：与 Simple3 源码同步
|
||||
> **更新日期**：2026-06-18
|
||||
> **服务栈**：EmbedIO WebApi（非 ASP.NET Core）
|
||||
> **OpenAPI**：`Docs/openapi/simplelite-projection.json`（已在 MiGu.Server Swagger UI 中展示）
|
||||
> **OpenAPI**：`Docs/openapi/simple3-projection.json`（已在 MiGu.Server Swagger UI 中展示）
|
||||
|
||||
---
|
||||
|
||||
## 1. 架构与访问路径
|
||||
|
||||
SimpleLite 在进程内启动 HTTP 投影服务，默认监听 `http://127.0.0.1:8222`。咪咕平台后端 **MiGu.Server** 通过 YARP 反向代理将请求转发到 SimpleLite。
|
||||
Simple3 在进程内启动 HTTP 投影服务，默认监听 `http://127.0.0.1:8222`。咪咕平台后端 **MiGu.Server** 通过 YARP 反向代理将请求转发到 Simple3。
|
||||
|
||||
| 层级 | 前缀 | 说明 |
|
||||
|------|------|------|
|
||||
| 直连 SimpleLite | `http://127.0.0.1:8222/projection/...` | 开发调试、本机回环 |
|
||||
| 直连 Simple3 | `http://127.0.0.1:8222/projection/...` | 开发调试、本机回环 |
|
||||
| 经 MiGu.Server | `http://{host}:8080/api/sl/projection/...` | 平台前端/运维正式入口 |
|
||||
|
||||
```
|
||||
@@ -23,7 +23,7 @@ SimpleLite 在进程内启动 HTTP 投影服务，默认监听 `http://127.0.0.1
|
||||
MiGu.Server :8080 (/api/sl/*)
|
||||
│ 追加 X-Platform-Internal-Token
|
||||
▼
|
||||
SimpleLite :8222 (/projection/*)
|
||||
Simple3 :8222 (/projection/*)
|
||||
```
|
||||
|
||||
### 1.1 鉴权
|
||||
@@ -31,12 +31,12 @@ SimpleLite :8222 (/projection/*)
|
||||
| 场景 | 要求 |
|
||||
|------|------|
|
||||
| 经 MiGu.Server 访问 | 需登录 JWT（`Authorization: Bearer` 或 Cookie `simple.auth.token`）；YARP 自动注入 `X-Platform-Internal-Token` |
|
||||
| 直连 SimpleLite | 本机回环（127.0.0.1 / ::1）默认放行；远程需携带与 MiGu.Server 共享的 `X-Platform-Internal-Token` |
|
||||
| 直连 Simple3 | 本机回环（127.0.0.1 / ::1）默认放行；远程需携带与 MiGu.Server 共享的 `X-Platform-Internal-Token` |
|
||||
|
||||
Token 解析优先级（SimpleLite 侧）：
|
||||
Token 解析优先级（Simple3 侧）：
|
||||
|
||||
1. `simple.json` → `platform.internalToken`
|
||||
2. 环境变量 `SIMPLELITE__PLATFORM__INTERNALTOKEN`
|
||||
2. 环境变量 `SIMPLE3__PLATFORM__INTERNALTOKEN`
|
||||
3. `Platform.Server/data/.internal-token` 或 `MiGu.Server/data/.internal-token`
|
||||
|
||||
### 1.2 通用响应格式
|
||||
@@ -60,8 +60,8 @@ Token 解析优先级（SimpleLite 侧）：
|
||||
|
||||
开发环境下启动 MiGu.Server 后访问：
|
||||
|
||||
- **统一文档**：`http://localhost:8080/swagger`（含 MiGu.Server 自有 API + SimpleLite 全部 WebApi）
|
||||
- SimpleLite 相关接口标签前缀为 `SimpleLite/`
|
||||
- **统一文档**：`http://localhost:8080/swagger`（含 MiGu.Server 自有 API + Simple3 全部 WebApi）
|
||||
- Simple3 相关接口标签前缀为 `Simple3/`
|
||||
|
||||
---
|
||||
|
||||
@@ -112,7 +112,7 @@ Token 解析优先级（SimpleLite 侧）：
|
||||
{
|
||||
"id": "C01",
|
||||
"name": "AGV-1",
|
||||
"typeName": "SimpleLite.RCS.CarTypes.Car",
|
||||
"typeName": "Simple3.RCS.CarTypes.Car",
|
||||
"rawId": 1,
|
||||
"x": 1200.5,
|
||||
"y": 800.0,
|
||||
@@ -285,7 +285,7 @@ Token 解析优先级（SimpleLite 侧）：
|
||||
|
||||
同一车型若多个 Coder 引用不同 Fields 类型，接口会合并后取**最派生、字段最全**的类型（如 Kiva 取 `KivaTrackFields` 而非 `BasicTrackFields`）。返回的 `fields` 数组**包含继承链上全部 public 字段**（例如 `KivaTrackFields` 会同时包含 `BasicTrackFields` 的 `IOArea`、`Speed` 等基类字段）。
|
||||
|
||||
> **实现说明**：Fields 类在插件程序集中多为 `internal`；插件已通过 `InternalsVisibleTo("SimpleLite")` 向 SimpleLite 开放。**插件在 collectible ALC 中加载时**，SimpleCore 特性类型与宿主不一致，须通过 `CustomAttributeData` 读取 Coder 上的 `siteFields`/`trackFields` 等 metadata（不能依赖 `GetCustomAttributes(typeof(TemplateTrackCoderSettings))`）。`StandardScene.dll` 内 Fields 由 `CoderFieldsMetadata.Describe` 在 Core 程序集内反射导出。
|
||||
> **实现说明**：Fields 类在插件程序集中多为 `internal`；插件已通过 `InternalsVisibleTo("Simple3")` 向 Simple3 开放。**插件在 collectible ALC 中加载时**，SimpleCore 特性类型与宿主不一致，须通过 `CustomAttributeData` 读取 Coder 上的 `siteFields`/`trackFields` 等 metadata（不能依赖 `GetCustomAttributes(typeof(TemplateTrackCoderSettings))`）。`StandardScene.dll` 内 Fields 由 `CoderFieldsMetadata.Describe` 在 Core 程序集内反射导出。
|
||||
|
||||
---
|
||||
|
||||
@@ -467,7 +467,7 @@ Token 解析优先级（SimpleLite 侧）：
|
||||
|
||||
咪咕 Vue 前端封装位于 `Migu2.0/frontends/apps/simple-platform-vue/src/api/`：
|
||||
|
||||
| 文件 | 对应 SimpleLite 前缀 |
|
||||
| 文件 | 对应 Simple3 前缀 |
|
||||
|------|----------------------|
|
||||
| `reflection.ts` | `/api/sl/projection/reflection` |
|
||||
| `mapEdit.ts` | `/api/sl/projection/map-edit` |
|
||||
@@ -480,16 +480,16 @@ Token 解析优先级（SimpleLite 侧）：
|
||||
|
||||
| 服务 | 默认端口 | 路径 |
|
||||
|------|----------|------|
|
||||
| MiGu.Server | 8080 | `/api/sl/*` → SimpleLite |
|
||||
| SimpleLite 投影 API | 8222 | `/projection/*` |
|
||||
| SimpleLite webVRender | 8223 | `/vr/*`（3D 嵌入 UI，非数据 API） |
|
||||
| MiGu.Server | 8080 | `/api/sl/*` → Simple3 |
|
||||
| Simple3 投影 API | 8222 | `/projection/*` |
|
||||
| Simple3 webVRender | 8223 | `/vr/*`（3D 嵌入 UI，非数据 API） |
|
||||
|
||||
**健康检查**：`GET http://localhost:8080/api/health/simplelite`
|
||||
**健康检查**：`GET http://localhost:8080/api/health/simple3`
|
||||
|
||||
**本地联调**：
|
||||
|
||||
```powershell
|
||||
# 1. 启动 SimpleLite（或登录 MiGu.Server 后自动拉起）
|
||||
# 1. 启动 Simple3（或登录 MiGu.Server 后自动拉起）
|
||||
# 2. 启动 MiGu.Server
|
||||
# 3. 浏览器打开 http://localhost:8080/swagger
|
||||
# 4. 授权 Bearer token 后测试 /api/sl/projection/cars
|
||||
|
||||
Reference in New Issue
Block a user