Need help with graphql-ppx?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

reasonml-community
214 Stars 38 Forks MIT License 871 Commits 22 Opened issues

Description

GraphQL language primitives for ReScript/ReasonML written in ReasonML

Services available

!
?

Need anything else?

Contributors list

Logo

Typesafe GraphQL operations and fragments in ReasonML

Build Status npm version

DocumentationFeaturesInstallationUsageRoadmapContributingLicenseAcknowledgements

Documentation

Go to the official documentation

Features

  • Language level GraphQL primitives

  • Building block for GraphQL clients

  • 100% type safe

Installation

Schema

graphql-ppx
needs your graphql schema to be available in the form of a
graphql_schema.json
file.

The easiest way to add this to your project is using an introspection query to your backend. You can do this using

get-graphql-schema
:
npx get-graphql-schema ENDPOINT_URL -j > graphql_schema.json

With

ENDPOINT_URL
being the URL of your GraphQL endpoint.

Cache

graphql-ppx
will generate a
.graphql_ppx_cache
folder alongside your JSON schema to optimize parsing performance. If you're using a version control system, you don't need to check it in.

The next pages will provide further installation instructions whether you are using

graphql-ppx
with Bucklescript or using Reason Native.

Bucklescript

First, add it to you dependencies using

npm
or
yarn
:
yarn add @reasonml-community/graphql-ppx --dev
# or
npm install @reasonml-community/graphql-ppx  --saveDev

Second, add it to

ppx-flags
and
bs-dependencies
in your
bsconfig.json
:
"ppx-flags": ["@reasonml-community/graphql-ppx/ppx"],
"bs-dependencies": ["@reasonml-community/graphql-ppx"]

Native

Caution!

The Bucklescript version of

graphql-ppx
was almost completely rewritten for the 1.0 release, with many improvements and changes. This documentation will focus on the API of the bucklescript version. This means that most of the examples won't apply for the Reason Native version. Please take a look at the old documentation. At the same time we welcome contributions to modernize the Reason Native version of
graphql-ppx
:::

You need to provide the following dependency in your

esy.json
file
{
  "dependencies": {
    "graphql-ppx": "*"
  },
  "resolutions": {
    "graphql-ppx": "reasonml-community/graphql-ppx:esy.json#"
  }
}

and update your

dune
file:
(preprocess (pps graphql_ppx))

Usage

Make your first query:

Reason

[%graphql {|
  query UserQuery {
    user {
      id
      name
    }
  }
|}];

ReScript

%graphql(`
  query UserQuery {
    user {
      id
      name
    }
  }
`)

Open getting started in the docs

Roadmap

See our development board for a list of selected features and issues.

Contributing

We'd love your help improving

graphql-ppx
!

Take a look at our Contributing Guide to get started.

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

Thanks to everyone who contributed to

graphql-ppx
!

This project builds upon mhallin/graphql_ppx. It wouldn't be possible without great work of mhallin/graphql_ppx contributors. 1

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.