GraphQL 模式文档构建器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/graphql-schema-documentation-builder。
技能介绍
要解决的问题
GraphQL 的 SDL 写到最后,字段加了又删、类型互相引用,团队里没人愿意再维护一份静态文档。手写文档容易和 schema 脱节,审查时也看不出字段被弃用或关系链断裂。
这个技能做什么
- 用
graphql-js的内省查询读取 SDL,生成可交互的 API 文档。 - 渲染类型关系图,把
Query、Mutation和各类型字段之间的依赖画清楚。 - 自动产出查询示例,减少手动补例子的成本。
- 对标记为
deprecated的字段输出弃用提示,避免调用方继续使用。 - 关键步骤:内省 → 结构化 → SpectaQL 渲染 → 输出静态页面。
适用边界
- 输入必须是合法的 GraphQL schema,最好来自
.graphql文件或可解析的 SDL 字符串。 - 依赖上游
graphql包;跨环境安装时要按 Node 服务是 CommonJS 还是 ESModule 选对应方式。 - 文档质量取决于内省结果,schema 本身不规范时,图表和示例也会失真。
使用场景
- 后端工程师在 GraphQL API 更新后,从 SDL 生成可交互文档并标注弃用字段
- 团队维护多个 GraphQL schema,需要可视化字段关联关系避免遗漏
- 上线前检查 GraphQL Schema 中的废弃字段,并生成查询示例代码
- 接手遗留 GraphQL 项目,需要快速梳理类型依赖关系和文档结构
适合人员
- 后端工程师:需要从 SDL 快速产出准确的 GraphQL API 文档,减少手写维护
- 技术文档工程师:需要持续同步最新的 GraphQL schema,并标注字段弃用状态
- 全栈开发者:希望在开发过程中查看可交互的类型关系图,辅助理解 schema 结构
- 技术负责人:需要在代码审查前检查 schema 变更,确认废弃字段不影响调用方