编程开发 通用 中文 English GraphQL API 设计 为本仓库中的 [feature or domain] 设计 GraphQL API。规则:客户端决定查询形状,因此服务器… 生成后的提示词 为本仓库中的 `[feature or domain]` 设计 GraphQL API。规则: **客户端决定查询形状,因此服务器必须承担成本**。采用 schema-first 进行设计,按字段授权,并让昂贵的查询故意失败, 而不是在生产环境中失败。 ## 步骤 1. **从领域建模,而不是从表建模** - 为此功能暴露的类型编写 SDL,按客户端需要命名字段,并让 mutation 保持粗粒度。有意标记可空性:一个非空字段抛出的 null 会传递给其父级,并可能使整个响应变为空白。 2. **先确定连接约定** - 处处使用一种分页风格,Relay cursor 或文档化的 offset/limit。一个不带参数的裸 `[Type]` 会招致无界查询,因此每个列表字段都接受 `first`/`last`,并记录最大限制。 3. **在编写 resolver 之前规划 N+1** - 标记每一个跨对象边界嵌套选择,例如 `Query.posts -> Post.author`。除非批处理,否则每个都是第二次查询。按边界选择策略(请求作用域的 DataLoader、联合 SQL 查询),并写下原因。 4. **按字段授权,而不是按查询授权** - 在数据解析的位置强制执行访问控制,因为顶层守卫无法保护嵌套字段。决定并记录字段对无访问权限的查看者的行为:隐藏它、返回 null,还是抛出类型化错误,并保持一致。 5. **设限并标准化** - 根据应用实际需要设置深度和字段数限制,而不是根据示例查询。给错误一个稳定的形状:机器可读的 `code`、用户安全的消息和请求 id。说明演进规则:默认增量式、`@deprecated(reason:)`,并有下线流程。 6. **用真实查询验证** - 运行一个深层嵌套查询、一个无界列表、一个查看者绝不能看到的字段,以及一个中途失败的 mutation。统计每个查询发出的查询次数并展示数字。 ## 验证 - [ ] SDL 已粘贴,且未将任何数据库列或表结构暴露为 schema。 - [ ] 每个列表字段都接受最大限制,因此没有查询是无界的。 - [ ] 批处理策略按嵌套边界编写,任何未解决的 N+1 都被明确指出,而不是交付。 - [ ] 深度和复杂度限制设置为具体数字,而不是保留默认值。 - [ ] 第 6 步的四个查询已运行,并展示每个查询测得的查询次数。 - [ ] 未授权字段的情况返回文档化行为,而不是数据。 ## 规则 - 绝不将数据库列或表结构暴露为 schema。Schema 是 契约,不是镜像。 - 绝不用每个父级一次查询来解析嵌套对象字段。如果 N+1 未解决, 在设计里说明,而不是交付。 - 绝不返回无界列表。每个列表字段都接受最大限制。 - 绝不依赖顶层认证检查来保护嵌套字段。 - 绝不在未将深度和复杂度限制设置为具体数字的情况下交付。 复制提示词 分享提示词 查看示例 发送到 AI 优化器 收藏模板 保存当前版本 示例 关闭 分享 卡片风格 雾面玻璃 暖白纸笺 深夜蓝图 薄荷网格 珊瑚日落 水墨笺 关闭 图片仅展示节选。