JavaScript:GraphQL Code Generator(代码生成工具)
graphql-github-io-zh-Hans生态项目与库
JavaScript:GraphQL Code Generator(代码生成工具)
简介
GraphQL Code Generator 是一个功能强大的代码生成工具,它通过解析 GraphQL Schema 与操作文档,自动生成类型安全的代码。该项目提供了灵活的自定义插件与模板机制,可帮助开发者显著减少手写样板代码。
该工具支持多种应用场景,包括:
-
TypeScript 前端与后端:生成类型定义、请求客户端、服务端解析器签名。
-
React Hooks:自动生成基于 React 的
useQuery、useMutation等类型安全 Hooks。 -
自定义插件:允许扩展生成逻辑,输出符合项目需求的任意代码。
-
npm 包:
@graphql-codegen/cli
核心特性
- 多语言/多框架支持:内置 TypeScript、JavaScript、React、Vue、Angular 等模板。
- 类型安全:根据 GraphQL Schema 自动推导 TypeScript 类型,避免前后端类型不一致。
- 可扩展架构:通过插件系统支持自定义代码生成规则,灵活适配不同工程需求。
- 集成友好:可与 GraphQL CLI、Webpack、VS Code 等工具链配合使用。
- Schema 与操作驱动:支持从本地文件、远程端点或代码中的 GraphQL 定义生成代码。
安装与基本使用
通过 npm 安装命令行工具:
bash
npm install -D @graphql-codegen/cli
初始化配置:
bash
npx graphql-codegen init
按照提示选择目标框架与插件,工具会自动创建 codegen.yml 配置文件,随后执行:
bash
npx graphql-codegen
即可根据配置生成对应代码。
相关资源
帮助我们改进文档
发现翻译问题或内容错误?请告诉我们。
