@baransu/graphql-ppx

This is README for the upcoming 1.0 release. It's available via "@baransu/graphql_ppx@next", contains breaking changes and may not work. If you're using 0.x version please check README from master branch

Typesafe GraphQL operations and fragments in ReasonML

Documentation • Features • Installation • Usage • Roadmap • Contributing • License • Acknowledgements

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 @baransu/graphql_ppx_re@next --dev
# or
npm install @baransu/graphql_ppx_re@next  --saveDev

Second, add it to ppx-flags and bs-dependencies in your bsconfig.json:

"ppx-flags": ["@baransu/graphql_ppx_re/ppx"],
"bs-dependencies": ["@baransu/graphql_ppx_re"]

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:

[%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.