![\"Logo\"](\"https://beta.graphql-ppx.com/img/logo.svg\"){kind=logo}
\n \t\n Typesafe GraphQL operations and fragments in ReasonML\n
\n \n \t
\n Typesafe GraphQL operations and fragments in ReasonML\n
\n Documentation •\n Features •\n Installation •\n Usage •\n Roadmap •\n Contributing •\n License •\n Acknowledgements\n
\n\n## Documentation\n\n[Go to the official documentation](https://beta.graphql-ppx.com)\n\n## Features\n\n- Language level GraphQL primitives\n\n- Building block for GraphQL clients\n\n- 100% type safe\n\n## Installation\n\n### Schema\n\n`graphql-ppx` needs your graphql schema to be available in the form of a\n`graphql_schema.json` file.\n\nThe easiest way to add this to your project is using an\n[introspection query](https://github.com/graphql/graphql-js/blob/master/src/utilities/introspectionQuery.js)\nto your backend. You can do this using `get-graphql-schema`:\n\n```sh\nnpx get-graphql-schema ENDPOINT_URL -j > graphql_schema.json\n```\n\nWith `ENDPOINT_URL` being the URL of your GraphQL endpoint.\n\n### Cache\n\n`graphql-ppx` will generate a `.graphql_ppx_cache` folder alongside your JSON\nschema to optimize parsing performance. If you're using a version control\nsystem, you don't need to check it in.\n\nThe next pages will provide further installation instructions whether you are\nusing `graphql-ppx` with Bucklescript or using Reason Native.\n\n### Bucklescript\n\nFirst, add it to you dependencies using `npm` or `yarn`:\n\n```sh\nyarn add @baransu/graphql_ppx_re@next --dev\n# or\nnpm install @baransu/graphql_ppx_re@next --saveDev\n```\n\nSecond, add it to `ppx-flags` and `bs-dependencies` in your `bsconfig.json`:\n\n```json\n\"ppx-flags\": [\"@baransu/graphql_ppx_re/ppx\"],\n\"bs-dependencies\": [\"@baransu/graphql_ppx_re\"]\n```\n\n### Native\n\n#### Caution!\n\nThe Bucklescript version of `graphql-ppx` was almost completely rewritten for the\n1.0 release, with many improvements and changes. This documentation will focus\non the API of the bucklescript version. This means that most of the examples\nwon't apply for the Reason Native version. Please take a look at the\n[old documentation](https://github.com/reasonml-community/graphql_ppx/tree/v0.7.1).\nAt the same time we welcome contributions to modernize the Reason Native version\nof `graphql-ppx`\n:::\n\nYou need to provide the following dependency in your `esy.json` file\n\n```json\n{\n \"dependencies\": {\n \"graphql_ppx\": \"*\"\n },\n \"resolutions\": {\n \"graphql_ppx\": \"reasonml-community/graphql_ppx:esy.json#![\"Build](\"https://github.com/reasonml-community/graphql_ppx/workflows/graphql_ppx%20pipeline/badge.svg\"){kind=icon}
\n ![\"npm](\"https://badge.fury.io/js/%40baransu%2Fgraphql_ppx_re.svg\"){kind=icon}
\n