-
Notifications
You must be signed in to change notification settings - Fork 368
[docs] spring-server documentation updates #456
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| id: spring-graphql-context | ||
| title: Generating GraphQL Context | ||
| --- | ||
|
|
||
| `graphql-kotlin-spring-server` provides a simple mechanism to build [GraphQL context](../execution/contextual-data) per query execution through | ||
| [GraphQLContextFactory](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-spring-server/src/main/kotlin/com/expediagroup/graphql/spring/execution/GraphQLContextFactory.kt). | ||
| Once context factory bean is available in the Spring application context it will then be used in a corresponding | ||
| [ContextWebFilter](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-spring-server/src/main/kotlin/com/expediagroup/graphql/spring/execution/ContextWebFilter.kt) | ||
| to populate GraphQL context based on the incoming request and make it available during query execution. | ||
|
|
||
| For example if we define our custom context as follows: | ||
|
|
||
| ```kotlin | ||
| data class MyGraphQLContext(val myCustomValue: String) | ||
| ``` | ||
|
|
||
| We can generate corresponding `GraphQLContextFactory` bean: | ||
|
|
||
| ```kotlin | ||
| @Component | ||
| class MyGraphQLContextFactory: GraphQLContextFactory<MyGraphQLContext> { | ||
| override suspend fun generateContext( | ||
| request: ServerHttpRequest, | ||
| response: ServerHttpResponse | ||
| ): MyGraphQLContext = MyGraphQLContext( | ||
| myCustomValue = request.headers.getFirst("MyHeader") ?: "defaultContext" | ||
| ) | ||
| } | ||
| ``` | ||
|
|
||
| Once your application is configured to build your custom `MyGraphQLContext`, we can then specify it as function argument by annotating it with `@GraphQLContext`. | ||
| While executing the query, the corresponding GraphQL context will be read from the environment and automatically injected to the function input arguments. | ||
|
|
||
| ```kotlin | ||
| @Component | ||
| class ContextualQuery: Query { | ||
| fun contextualQuery( | ||
| value: Int, | ||
| @GraphQLContext context: MyGraphQLContext | ||
| ): ContextualResponse = ContextualResponse(value, context.myCustomValue) | ||
| } | ||
| ``` | ||
|
|
||
| The above query would produce the following GraphQL schema: | ||
|
|
||
| ```graphql | ||
| schema { | ||
| query: Query | ||
| } | ||
|
|
||
| type Query { | ||
| contextualQuery( | ||
| value: Int! | ||
| ): ContextualResponse! | ||
| } | ||
| ``` | ||
|
|
||
| Notice that the `@GraphQLContext` annotated argument is not reflected in the generated GraphQL schema. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.