rlwj-lab/opsxapi
0
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 锁定 apps/desktop 目录权威与 SDD 短模板

Browse Source 
- AGENTS/architecture：目录权威改为 apps/desktop + packages/* + apps/server；根 src 标误迁
- sdd-template：补何时必填与 FR→AC，保留 Shell/DB 短模板体；细流程仍 docs/specs/
- 安全三行钉死；HANDTEST/README 已无浏览器 :5173 工作台口径
This commit is contained in:
logan committed 2026-10-19 21:27:13 +08:00
1 parent 9304b0e98c
commit 0c0423d3a1
4 files changed
+55 -88
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/architecture.md
+18 -30
View File
@@ -1,50 +1,38 @@
# 架构说明
一页。细节以代码和 [AGENTS.md](../AGENTS.md) 为准，不在这里重写功能清单。
一页。规则以 [AGENTS.md](../AGENTS.md) 为准。
## 两套壳
| 壳 | 入口 | 做什么 | 不做什么 |
| --- | --- | --- | --- |
| 浏览器 | `./run.sh web` → `http://127.0.0.1:8787/` | 官网、`/docs`、定价（`homepage/dist`） | 请求、集合、Mock 管理、自动化测试 |
| 桌面 | `./run.sh gui` | 全部操作（Tauri WebView + Rust） | 不把这套 UI 当成浏览器产品 |
Vite 开发源只给桌面 WebView。不要用浏览器打开它当工作台。
| 浏览器 | `./run.sh web` → `http://127.0.0.1:8787/` | 官网、文档、定价（`homepage/`） | 请求、集合、Mock 管理、自动化测试 |
| 桌面 | `./run.sh gui` | 全部操作 | 不把这套 UI 当成浏览器产品 |
## 目录权威
当前 `main` 是扁平根目录，**不是** monorepo：
```text
src/ 唯一产品 UI（React）
src/transport/ 请求传输；Tauri 调用只走 ipc.ts
src/features/ 功能域
src/components/ 界面组合
src-tauri/ Tauri 2；command 适配，业务在 src/services/
server/ Gin 管理面（默认 127.0.0.1:8787）+ Mock 响应监听
homepage/ 官网与文档源
tools/homepage-build/ 静态站构建
apps/desktop 桌面 Tauri（唯一操作入口的代码）
packages/* 共享 UI / 传输 / 领域
apps/server Gin：官网静态托管、代理、本机 API
homepage/ 官网与文档源
```
`apps/desktop`、`apps/web`、`apps/server`、`packages/*` 在本仓库不存在。`docs/recovery/2026-10-14.md` 里的 `packages/` 是扁平化中途快照，不是现行路径。不要迁回，也不要再建第二棵 UI。
根目录 `src/`、`src-tauri/`、根 `server/` 是误迁，不算权威，不要在上面继续长功能。
## 数据流
```text
桌面 UI
→ src/transport（直连 / Gin 代理 / Tauri）
→ 127.0.0.1:8787 代理、账号、工作区、Mock 发布（仅本机管理）
→ :8798 已发布 Mock 与只读文档分享（默认仅回环/私网来源）
homepage/dist
→ Gin 静态托管，与集合数据无关
apps/desktop
→ packages/*（传输与领域）
→ apps/server 127.0.0.1 管理 / 代理 / Mock 发布
→ Mock 响应 默认 127.0.0.1（不对公网）
homepage
→ 浏览器只读官网与文档，不碰集合与密钥
```
- 集合、环境、Mock 草稿在本机；发布进本机 SQLite，不因登录改存公网。
- 实时协议会话不落盘。
- 分享快照不含鉴权、环境变量和运行历史。
## 安全三行
## 安全底线
1. **浏览器只站 + 文档。** 工作台只在 `./run.sh gui`。不要把操作面加回官网。
2. **Mock 不上公网。** 管理 API 留在 `127.0.0.1:8787`。`:8798` 默认拒绝公网来源；要放开必须显式 `OPSXAPI_MOCK_ALLOW_PUBLIC=1`，且仍不开放发布/账号/代理管理。只本机时用 `OPSXAPI_MOCK_ADDR=127.0.0.1:8798`。
3. **敏感不明文。** 无对公 `/admin`。令牌、密钥、未发布数据不进官网、文档分享和 Mock 响应正文。分享用随机令牌，不暴露空间归属。
1. 浏览器只看站 / 文档。操作只走 `./run.sh gui`。
2. Mock 默认 `127.0.0.1`，不上公网。
3. `/admin` 不落明文。
docs/sdd-template.md
+7 -3
View File
@@ -1,4 +1,10 @@
# SDD 模板路径: docs/sdd-template.md
# SDD 模板（S2 / S3 必填）
**何时必填：** S2（新功能、接口/配置/数据模型、跨模块行为）和 S3（权限、安全、迁移/删除、生产变更）动工前填本模板。S0 文案与 S1 契约内修复直接改代码，不套本模板。
**FR → AC：** 第 2 节每条 FR/NFR 在第 5 节有对应 AC（前置、操作、预期、验证方式）。S3 另填第 6 节发布与恢复。
细流程、评审状态与规格索引仍是 [docs/specs/README.md](specs/README.md)；入库长表用 [docs/specs/_template.md](specs/_template.md)。不另造第三套字段。
# SDD 模板（S2 / S3 使用）
@@ -60,5 +66,3 @@
| 问题 | 是否阻塞 | 推荐方案 |
|------|----------|----------|
| | | |
细流程、状态机与规格索引见 [docs/specs/README.md](specs/README.md)，长表用 [docs/specs/_template.md](specs/_template.md)。两套不并行发明第三份字段；S2/S3 起草可先填本短模板，评审入库时落到 `docs/specs/<domain>/<slug>.md`。