SuperAPI AI 工具集

public-graphql-api-design

编程与开发

查看项目

更新于 10-16 08:44

技能介绍

用途:帮助设计公开 GraphQL API,使未知第三方开发者能安全查询,并保持 schema 可演进、平台稳定。

主要能力:先判断该 API 是否值得用 GraphQL(默认 REST,仅在多类客户端需要同一数据的不同形态、嵌套可变数据、移动端往返次数敏感等触发条件成立时采用,也接受 REST 与 GraphQL 混合)。然后设定 schema 约定:PascalCase 类型、camelCase 字段、SCREAMING_SNAKE_CASE 枚举、布尔加 is/has/can 前缀;变更按业务动作命名并选定动词优先或名词优先风格;每次变更使用专属输入与负载类型;空值与 ID 策略明确,实现 Node 接口,暴露对象引用而非外键字段,按客户端用例而非数据库表设计类型,公开文档字符串不泄露内部系统。列表字段采用 Relay 游标连接(edges/node/cursor/pageInfo,first/after),服务端限制页大小。错误面采用混合策略:顶层内置错误用于服务故障与认证,业务结果使用 union/interface 结果类型,并配共享错误码枚举。护栏包括解析期深度上限、别名与根字段上限、批量操作上限、按操作成本上限、内省控制、DataLoader 批处理,以及未授权字段的统一 null 与错误行为,所有上限需公开文档化。联邦仅暴露路由器,子图不可直接访问,并说明禁用内省不足以保护子图。

限制:资料未提供具体收费、价格、效果数据、安装命令及完整实现步骤;部分细节属建议性内容,需结合团队实际验证。