graphql_ppx

GraphQL PPX rewriter for ReScript/ReasonML
README

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#<use latest stable commit from master>"
  }
}

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

Install
Published
28 Jul 2021
Sources
v1.2.2.tar.gz
md5=00455e2a595b925a697fd7e80aab3fb8
sha512=b6e0a5b353b6498c10d03a37ab4a2083ca0d17f227fa906e7c6f07053a7a9198476b7aa7d0e88f4e3c8c44a85469eb3a65805cd6d006ef64ff82fe5bc3524881
Dependencies
yojson
>= "1.6.0"
ppxlib
>= "0.21.0"
ocaml
>= "4.06"
dune
>= "2.5"
alcotest
with-test
Reverse Dependencies