Skip to content
This repository has been archived by the owner on Feb 12, 2023. It is now read-only.

mkmarek/graphql-dotnetcore

Repository files navigation

Library for creating GraphQL servers with .NET core.

Build Status Coverage Status NuGet MyGet Pre Release

Code Example

public class Query : GraphQLObjectType
{
	public Query() : base("Query", "Root query defintion")
	{
		this.Field("sum", (int[] numbers) => numbers.Sum());
	}
}

public class MyAwesomeSchema : GraphQLSchema
{
    public MyAwesomeSchema()
    {
        var rootQuery = new Query();
        this.AddKnownType(rootQuery);
        this.Query(rootQuery);
    }
}

[Route("api/[controller]")]
public class GraphQLController : Controller
{
    private MyAwesomeSchema schema = new MyAwesomeSchema();

    [HttpPost]
    public JsonResult Post(string query)
    {
        return this.Json(
            new
            {
                data = this.schema.Execute(query)
            }
        );
    }
}

Query

{
  sum(numbers: [1,2,3])
}

Result

{
  "sum" : 6
}

Interested? Have a look on a better example here!

Documentation

  1. Scalar type translation
  2. Nullability
  3. Untyped object definition
  4. Typed object definition
  5. Interfaces
  6. Input object definition
  7. Schema
    • Queries
    • Mutations
    • Subscriptions (TBD)
    • Execution
  8. Introspection
  9. Validation
  10. Roadmap

Contributions

Wanna contribute? Awesome! Please follow this process to get your feature or bugfix in place.

Fork it

Clone it

git clone https://github.com/<your_username>/graphql-dotnetcore.git
cd graphql-dotnetcore

Do it

git checkout develop
...
git add -A
git commit -m "Awesome feature"
...
git add -A
git commit -m "Fix awesome feature"
...
git add -A
git commit -m "Fix the previous fix for awesome feature"
...

Squash it

git rebase -i <commit>

More info about squashing http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html.

Push it

git push

Request it

The final step will be creating a pull request. Refer the github docs for more details about that https://help.github.com/articles/using-pull-requests/