Skip to content

Commit 5e581ee

Browse files
authored
Merge pull request graph-gophers#405 from obeis/master
Improve README.md graph-gophers#307
2 parents c1d9693 + f3aefbe commit 5e581ee

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,17 @@ func (r *helloWorldResolver) Hello(ctx context.Context) (string, error) {
100100
}
101101
```
102102

103+
### Schema Options
104+
105+
- `UseStringDescriptions()` enables the usage of double quoted and triple quoted. When this is not enabled, comments are parsed as descriptions instead.
106+
- `UseFieldResolvers()` specifies whether to use struct field resolvers.
107+
- `MaxDepth(n int)` specifies the maximum field nesting depth in a query. The default is 0 which disables max depth checking.
108+
- `MaxParallelism(n int)` specifies the maximum number of resolvers per request allowed to run in parallel. The default is 10.
109+
- `Tracer(tracer trace.Tracer)` is used to trace queries and fields. It defaults to `trace.OpenTracingTracer`.
110+
- `ValidationTracer(tracer trace.ValidationTracer)` is used to trace validation errors. It defaults to `trace.NoopValidationTracer`.
111+
- `Logger(logger log.Logger)` is used to log panics during query execution. It defaults to `exec.DefaultLogger`.
112+
- `DisableIntrospection()` disables introspection queries.
113+
103114
### Custom Errors
104115

105116
Errors returned by resolvers can include custom extensions by implementing the `ResolverError` interface:
@@ -151,12 +162,6 @@ Which could produce a GraphQL error such as:
151162
}
152163
```
153164

154-
### Community Examples
155-
156-
[tonyghita/graphql-go-example](https://github.com/tonyghita/graphql-go-example) - A more "productionized" version of the Star Wars API example given in this repository.
157-
158-
[deltaskelta/graphql-go-pets-example](https://github.com/deltaskelta/graphql-go-pets-example) - graphql-go resolving against a sqlite database.
159-
160-
[OscarYuen/go-graphql-starter](https://github.com/OscarYuen/go-graphql-starter) - A starter application integrated with dataloader, psql and basic authentication.
165+
### [Examples](https://github.com/graph-gophers/graphql-go/wiki/Examples)
161166

162-
[zaydek/graphql-go-walkthrough](https://github.com/ZAYDEK/graphql-go-walkthrough) - A beginner friendly walkthrough for prospective developers.
167+
### [Companies that use this library](https://github.com/graph-gophers/graphql-go/wiki/Users)

0 commit comments

Comments
 (0)