Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds docs for how resolvers are bound #338

Merged
merged 2 commits into from
Sep 12, 2018
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
203 changes: 203 additions & 0 deletions docs/content/reference/resolvers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
---
linkTitle: Resolvers
title: Resolving grapqhQL requests
description: Different ways of binding graphQL requests to resolvers
menu: { main: { parent: 'reference' } }
---

There are multiple ways that a graphQL type can be bound to a Go struct that allows for many usecases.


## Bind directly to struct field names
This is the most common use case where the names of the fields on the Go struct match the names of the
fields in the graphQL type. If a Go struct field is unexported, it will not be bound to the graphQL type.

```go
type Car struct {
Make string
Model string
Color string
OdometerReading int
}
```

And then in your graphQL schema:
```graphql
type Car {
make: String!
model: String!
color: String!
odometerReading: Int!
}
```

And in the gqlgen config file:
```yaml
models:
Car:
model: github.com/my/app/models.Car
```

In this case, each filed in the graphQL type will be bound to the respective field on the go struct
ignoring the case of the fields


## Bind to a method name

This is also very common use case that comes up where we want to bind a graphQL field to a Go struct method

```go
type Person {
Name string
}

type Car struct {
Make string
Model string
Color string
OwnerID *string
OdometerReading int
}

func (c *Car) Owner() (*Person) {
// get the car owner
//....
return owner
}
```

And then in your graphQL schema:
```graphql
type Car {
make: String!
model: String!
color: String!
odometerReading: Int!
owner: Person
}
```

And in the gqlgen config file:
```yaml
models:
Car:
model: github.com/my/app/models.Car
Person:
model: github.com/my/app/models.Person
```

Here, we see that there is a method on car with the name ```Owner```, thus the ```Owner``` function will be called if
a graphQL request includes that field to be resolved

## Bind when the field names do not match

There are two ways you can bind to fields when the the Go struct and the graphQL type do not match.


The first way is you can bind resolvers to a struct based off of struct tags like the following:

```go
type Car struct {
Make string
ShortState string
LongState string `gqlgen:"state"`
Model string
Color string
OdometerReading int
}
```

And then in your graphQL schema:
```graphql
type Car {
make: String!
model: String!
state: String!
color: String!
odometerReading: Int!
}
```

And in the gqlgen config file add the line:
```yaml
struct_tag: gqlgen

models:
Car:
model: github.com/my/app/models.Car
```

Here even though the graphQL type and Go struct have different field names, there is a Go struct tag field on ```longState```
That matches and thus ```state``` will be bound to ```LongState```


The second way you can bind fields is by adding a line into the config file such as:
```go
type Car struct {
Make string
ShortState string
LongState string
Model string
Color string
OdometerReading int
}
```

And then in your graphQL schema:
```graphql
type Car {
make: String!
model: String!
state: String!
color: String!
odometerReading: Int!
}
```

And in the gqlgen config file add the line:
```yaml
models:
Car:
model: github.com/my/app/models.Car
fields:
state:
fieldName: LongState
```

## Binding to Anonymous or Embedded Structs
All of the rules from above apply to a struct that has an embedded struct.

```go
type Truck {
car
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be Car?


is4x4 bool
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be Is4x4?

}

type Car struct {
Make string
ShortState string
LongState string
Model string
Color string
OdometerReading int
}
```

And then in your graphQL schema:
```graphql
type Truck {
make: String!
model: String!
state: String!
color: String!
odometerReading: Int!
is4x4: Bool!
}
```
vektah marked this conversation as resolved.
Show resolved Hide resolved

Here all the fields from the Go struct Car will still be bound to the respective fields in the graphQL schema that match

## Binding Priority
If a ```struct_tags``` config exists, then struct tag binding has the highest priority over all other types of binding.
In all other cases, the first Go struct field found that matches the graphQL type field will be the field that is bound.