graphql-code-generator README

The project's README from github.com/dotansimha/graphql-code-generator. As one markdown file: README.md.

GraphQL Code Generator logo Created by The Guild

npm version

https://the-guild.dev/graphql/codegen

GraphQL Code Generator is a tool that generates code out of your GraphQL schema. Whether you are developing a frontend or backend, you can utilize GraphQL Code Generator to generate output from your GraphQL Schema and GraphQL Documents (query/mutation/subscription/fragment).

By analyzing the schema and documents and parsing it, GraphQL Code Generator can output code at a wide variety of formats, based on pre-defined templates or based on custom user-defined ones. Regardless of the language that you're using, GraphQL Code Generator has you covered.

GraphQL Code Generator lets you choose the output that you need, based on plugins, which are very flexible and customizable. You can also write your plugins to generate custom outputs that match your needs.

You can try this tool live on your browser and see some useful examples. Check out GraphQL Code Generator Live Examples.

We currently support and maintain these plugins (TypeScript, Flow, React, Angular, MongoDB, Stencil, Reason, and some more), and there is an active community that writes and maintains custom plugins.

Quick Start

You can find the complete instructions in GraphQL Code Generator website.

Start by installing the basic deps of GraphQL Codegen:

pnpm add graphql
pnpm add -D @graphql-codegen/cli

GraphQL Code Generator lets you setup everything by simply running the following command:

pnpm graphql-codegen init

Question by question, it will guide you through the whole process of setting up a schema, selecting plugins, picking a destination of a generated file, and a lot more.

If you wish to manually setup codegen, follow these instructions.

Besides our docs page, feel free to go through our published Medium articles to get a better grasp of what GraphQL Code Generator is all about:

Contributing

If this is your first time contributing to this project, please do read our Contributor Workflow Guide before you get started off.

Feel free to open issues and pull requests. We're always welcome support from the community.

For a contribution guide specific to this project, please refer to: http://the-guild.dev/graphql/codegen/docs/custom-codegen/contributing.

Code of Conduct

Help us keep GraphQL Code Generator open and inclusive. Please read and follow our Code of Conduct as adopted from Contributor Covenant

License

GitHub license

MIT

graphql-code-generator (dotansimha/graphql-code-generator)

Searching Database…

11.3K ·GitHub
Graphql-code-generator
Что это такое?GraphQL Code Generator — это инструмент, который генерирует код из вашей схемы GraphQL и операций (запросов, мутаций, подписок, фрагментов), создавая типизированный результат на том языке или во фреймворке, которые вы настроите с помощью плагинов.
Это CLI-инструмент или библиотека, которую я импортирую в свой код?В первую очередь это CLI, который вы запускаете для своей схемы и документов GraphQL. Сам результат создаётся системой плагинов (TypeScript, Flow, React, Angular, Stencil и другие), а не кодом, который вы пишете вручную.
Как запустить это в моём проекте?Установите базовые зависимости GraphQL Codegen, затем запустите команду настройки: она проведёт вас через вопросы о выборе схемы, плагинов и места для результата. Также поддерживается ручная настройка.
Что нужно подготовить перед запуском?Среду Node.js версии 16 или новее, существующую схему GraphQL и ваши документы с запросами, мутациями, подписками и фрагментами, для которых будет генерироваться код.
Нужно ли писать собственный плагин, чтобы получить нужный результат?Обычно нет: есть поддерживаемые плагины для TypeScript, Flow, React, Angular, MongoDB, Stencil и Reason, а также много плагинов от сообщества. Если ни один не подходит, всё равно можно написать свой плагин.
Какие языки и фреймворки поддерживаются из коробки?Официально поддерживаемые плагины охватывают TypeScript, Flow, React, Angular, MongoDB, Stencil и Reason, а плагины от сообщества расширяют поддержку и на другие языки, например Java и C#.
Можно ли попробовать это, ничего не настраивая?Да, на сайте проекта есть живые примеры в браузере, так что можно увидеть результат генерации до добавления инструмента в проект.
Можно ли использовать это и для фронтенда, и для бэкенда?Да, в README сказано, что инструмент подходит как для фронтенда, так и для бэкенда: код генерируется из одной и той же схемы GraphQL в любом случае.
What are similar projects?apollo-server, quicktype, forge, razzle, generator-jhipster, reverse-api-engineer, mitosis, gqlgen
Which topics is it in?codegen, schema, angular, graphql, code-generation, csharp, cli-tool, java, backend, plugin, command-line-tool, android
Creator
dotansimha
Size
94.9 MB
Stars
11.3K
Updated
CommitOct 12Releaserelease-1791804678827Oct 12
Age
9y
Commits · 90 Days