接口先想客户端的Skill

设计符合最佳实践的 GraphQL 架构。

graphql-schema 是一份指导 GraphQL 接口类型设计的 Skill。它从客户端要问什么出发,避免把数据库表直接变成一套难用的查询入口。

例如同一个搜索结果可能是用户、文章或评论,类型应说明这些可能性;创建用户时,提交的输入与返回的对象也分开定义。业务动作使用清楚的名称,而不只照搬增删改查。

空值约定同样要写明:列表能否为空、其中的元素能否为空,是两个问题。主文偏好非空列表和非空元素,但这只是接口契约,不能凭加叹号保证后端真的总有数据。

现有字段先标废弃再考虑移除,给调用方迁移时间。具体分页、错误与安全细则另有引用,本文不展开未读部分;适合拿真实调用场景与旧客户端约束一起评审,不能仅看类型文件漂亮就认定接口可用。

分类:编程开发

来源仓库:apollographql/skills

适合用来做什么

  • 请为我生成一个GraphQL模式。
  • 使用graphql-schema技能优化现有的模式。

安装 graphql-schema

npx skills add https://www.iskills.cc/skills/apollographql/skills/graphql-schema/SKILL.md

在本机终端执行安装命令。安装前请阅读原始说明,确认所需工具、账号和权限。

查看安装步骤 · 查看常见问题

查看 graphql-schema 的用途与原始说明

浏览全部 Skill 指南