Contents

## GraphQL::Stitching::Request

A `Request` contains a parsed GraphQL document and variables, and handles the logistics of extracting the appropriate operation, variable definitions, and fragments. A `Request` should be built once per server request and passed through to other stitching components that utilize request information.

```ruby
document = "query FetchMovie($id: ID!) { movie(id:$id) { id genre } }"
request = GraphQL::Stitching::Request.new(document, variables: { "id" => "1" }, operation_name: "FetchMovie")

request.document # parsed AST via GraphQL.parse
request.variables # user-submitted variables
request.string # normalized printed document string
request.digest # SHA digest of the normalized document string

request.variable_definitions # a mapping of variable names to their type definitions
request.fragment_definitions # a mapping of fragment names to their fragment definitions
```

### Preparing requests

A request should be prepared using the `prepare!` method before using it:

```ruby
document = <<~GRAPHQL
  query FetchMovie($id: ID!, $lang: String = "en", $withShowtimes: Boolean = true) {
    movie(id:$id) {
      id
      title(lang: $lang)
      showtimes @include(if: $withShowtimes) {
        time
      }
    }
  }
GRAPHQL

request = GraphQL::Stitching::Request.new(
  document,
  variables: { "id" => "1" },
  operation_name: "FetchMovie",
)

request.prepare!
```

Preparing a request will apply several destructive transformations:

- Default values from variable definitions will be added to request variables.
- The document will be pre-shaped based on `@skip` and `@include` directives.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
graphql-stitching-0.2.1	docs/request.md