GraphQL for .NET

This is an implementation of Facebook's GraphQL in .NET.

This project uses a lexer/parser originally written by Marek Magdziak and released with a MIT license. Thank you Marek!

Installation

You can install the latest version via NuGet.

PM> Install-Package GraphQL

Upgrade Guide

0.11.0
0.8.0

GraphiQL sample

There is a sample web api project hosting the GraphiQL interface. yarn install and yarn start from the root of the repository, then run the web project from Visual Studio.

Note: Before running the GraphiQL project: make sure you Build the entire solution so that all the project references get built. (GraphQL, GraphQL-Parser, etc) to avoid missing reference/assembly errors.

> npm install -g yarn
> yarn install
> yarn start

Usage

Define your schema with a top level query object then execute that query.

A more full-featured example including all classes required can be found here.

Hello World

var schema = Schema.For(@"
  type Query {
    hello: String
  }
");

var root = new { Hello = "Hello World!" };
var result = schema.Execute(_ =>
{
  _.Query = "{ hello }";
  _.Root = root;
});

Console.WriteLine(result);

Handler/Endpoints

public class Droid
{
  public string Id { get; set; }
  public string Name { get; set; }
}

public class Query
{
  [GraphQLMetadata("hero")]
  public Droid GetHero()
  {
    return new Droid { Id = "123", Name = "R2-D2" };
  }
}

var schema = Schema.For(@"
  type Droid {
    id: String
    name: String
  }

  type Query {
    hero: Droid
  }
", _ => {
    _.Types.Include<Query>();
});

var result = schema.Execute(_ =>
{
  _.Query = "{ hero { id name } }";
});

Parameters

public class Droid
{
  public string Id { get; set; }
  public string Name { get; set; }
}

public class Query
{
  private List<Droid> _droids = new List<Droid>
  {
    new Droid { Id = "123", Name = "R2-D2" }
  };

  [GraphQLMetadata("hero")]
  public Droid GetHero(string id)
  {
    return _droids.FirstOrDefault(x => x.Id == id);
  }
}

var schema = Schema.For(@"
  type Droid {
    id: String
    name: String
  }

  type Query {
    hero(id: String): Droid
  }
", _ => {
    _.Types.Include<Query>();
});

string id = "123";
var result = schema.Execute(_ =>
{
  _.Query = $"{{ hero(id: \"{id}\") {{ id name }} }}";
});

Roadmap

Grammar / AST

Grammar and AST for the GraphQL language should be compatible with the April 2016 specification.

Operation Execution

Validation

Schema Introspection

Publishing Nugets

yarn run setVersion 0.17.0
git commit/push
download nuget from AppVeyor
upload nuget package to github
publish nuget from MyGet

Publishing Documentation

Publishing documentation requires access to https://github.com/graphql-dotnet/graphql-dotnet.github.io

cd docs
./publish_docs.sh 2.0.0

Running on .NET Core

The GraphQL.GraphiQLCore project runs on .NET Core 1.1. You can run from Visual Studio Code or from the command line using dotnet run. When you run the project, you will see the GraphiQL editor open.

When using Visual Studio Code, open to the ./src/GraphQL.GraphiQLCore folder. You will get a warning "Required assets to build and debug are missing from 'GraphQL.GraphiQLCore'. Add Them?". Choose Yes. This will add the necessary launch.json and tasks.json files.

Running on OSX with mono

To run this project on OSX with mono you will need to add some configuration. Make sure mono is installed and add the following to your bash configuration:

export FrameworkPathOverride=/Library/Frameworks/Mono.framework/Versions/4.6.2/lib/mono/4.5/

See the following for more details:

ltouro/graphql-dotnet