v0.14.0 v0.17.15 v0.17.14 v0.17.13 v0.17.12 v0.17.11 v0.17.10 v0.17.9 v0.17.8 v0.17.7 v0.17.6 v0.17.5 v0.17.4 v0.17.3 v0.17.2 v0.17.1 v0.17.0 v0.16.0 v0.15.1 v0.15.0 master


How to configure gqlgen using gqlgen.yml
You are looking at the docs for an older version (v0.14.0). The latest version is v0.17.15.

gqlgen can be configured using a gqlgen.yml file, by default it will be loaded from the current directory, or any parent directory.


# Where are all the schema files located? globs are supported eg  src/**/*.graphqls
  - graph/*.graphqls

# Where should the generated server code go?
  filename: graph/generated/generated.go
  package: generated

# Enable Apollo federation support
  filename: graph/generated/federation.go
  package: generated

# Where should any generated models go?
  filename: graph/model/models_gen.go
  package: model

# Where should the resolver implementations go?
  layout: follow-schema
  dir: graph
  package: graph
  filename_template: "{name}.resolvers.go"

# Optional: turn on use ` + "`" + `gqlgen:"fieldName"` + "`" + ` tags in your models
# struct_tag: json

# Optional: turn on to use []Thing instead of []*Thing
# omit_slice_element_pointers: false

# Optional: set to speed up generation time by not performing a final validation pass.
# skip_validation: true

# gqlgen will search for any type names in the schema in these go packages
# if they match it will use them, otherwise it will generate them.
  - "github.com/your/app/graph/model"

# This section declares type mapping between the GraphQL and go type systems
# The first line in each type will be used as defaults for resolver arguments and
# modelgen, the others will be allowed when binding to fields. Configure them to
# your liking
      - github.com/99designs/gqlgen/graphql.ID
      - github.com/99designs/gqlgen/graphql.Int
      - github.com/99designs/gqlgen/graphql.Int64
      - github.com/99designs/gqlgen/graphql.Int32
      - github.com/99designs/gqlgen/graphql.Int
      - github.com/99designs/gqlgen/graphql.Int64
      - github.com/99designs/gqlgen/graphql.Int32

Everything has defaults, so add things as you need.

Inline config with directives

gqlgen ships with some builtin directives that make it a little easier to manage wiring.

To start using them you first need to define them:

directive @goModel(model: String, models: [String!]) on OBJECT
    | SCALAR
    | ENUM
    | UNION

directive @goField(forceResolver: Boolean, name: String) on INPUT_FIELD_DEFINITION

Here be dragons

gqlgen doesnt currently support user-configurable directives for SCALAR, ENUM, INTERFACE or UNION. This only works for internal directives. You can track the progress here

Now you can use these directives when defining types in your schema:

type User @goModel(model: "github.com/my/app/models.User") {
    id: ID!         @goField(name: "todoId")
    name: String!   @goField(forceResolver: true)