Skip to content

全面统一前后端 API 查询语法为 Spec 正典格式(包含文档、后端与前端 SDK/Studio) #989

@xuyushun441-sys

Description

@xuyushun441-sys

目标

将前后端所有 API 查询语法彻底统一为 Spec 协议正典格式,减少歧义与兼容层,为生态长期可维护性和开发者体验打下基础。

需要覆盖的范围

1. 后端 Runtime(REST Transport)

  • {HttpDispatcher}
    • 将 HTTP Query 层参数(filter/filters, sort, top, skip, select, expand)归一化为 QuerySchema (where, orderBy, limit, offset, fields, expand) 只传递 Spec 正典协议�� broker 层。
    • 明确 legacy 兼容段落和所有兼容代码标为 @deprecated,代码与注释加标记。

2. 前端 Client SDK

  • {Client SDK}
    • 新增全新 QueryOptionsV2,仅保留正典协议字段名(where, orderBy, limit, offset, fields ...)
    • 现有 find, findByIdquery 方法参数应支持新版,老版参数保留一版 deprecated
    • 重要提醒:所有 legacy 字段(filter, filters, sort, top, skip, select)加 deprecated 标记,完善注释和类型提示。
  • {QueryBuilder}
    • .skip() 等方法名保留,推进 .offset() alias 统一;所有构建 query JSON 的地方内部归一化输出为正典格式

3. 前端 UI(Hooks + Studio)

  • {useQuery, useMutation}
    • options 上全部改为 whereorderBylimitoffsetfields ...,旧参数 deprecated
    • 向下调用统一走新版 SDK 正典 API
  • {Studio QueryBuilder}
    • buildQueryJson 产出符合 spec 正典定义的 query,数据流全线升级

4. 文档

  • protocol、objectql/query-syntax.mdx
  • guides/contracts/data-engine.mdx
  • guides/client-sdk.mdx
  • references/api/protocol.mdx
  • protocol/objectos/http-protocol.mdx
  • 等所有涉及 Query API 的文档
  • 所有示例仅用 spec 正典格式
  • 各页面说明 HTTP transport 参数(filter/top/skip/expand)与协议模型字段名(where/limit/offset)关系,并补充拆分归一化过程,并强调优先级(如 only use filter, filters is deprecated...)

5. 自动化与测试

  • 检查所有自动化测试、mock handlers、及 E2E、MSW、Hono 测试,所有 query 相关的字段名统一并 drop 所有兼容判断。

交付标准

  • 后端、SDK、前端、Studio 与文档完全对齐正典语法,所有兼容层和别名明确 deprecated,开发体验一贯性。
  • 自动测试覆盖所有新旧字段,保证兼容性提示无遗漏。
  • 代码/文档/注释清晰指出任何即将移���或保留兼容期限的功能点。
  • 完成后及时 update ROADMAP.md。
  • 完成每项子任务后务必运行测试,确保未引入回归问题,并在对应 issue 及时更新进展。

这一 Issue 融合了原 #987 及实际代码库各层次发现的问题,务必注重代码长期演进的可维护性。

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions