Skip to content

Commit d676ea3

Browse files
mandiwisebenjie
mandiwise
and
benjie
committed
Update serving over HTTP docs. (graphql#1813)
Co-authored-by: Benjie <[email protected]>
1 parent eabd316 commit d676ea3

File tree

1 file changed

+96
-27
lines changed

1 file changed

+96
-27
lines changed

‎src/pages/learn/serving-over-http.mdx

Lines changed: 96 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,65 @@
1+
import { Callout } from "nextra/components"
2+
13
# Serving over HTTP
24

3-
HTTP is the most common choice for client-server protocol when using GraphQL because of its ubiquity. Here are some guidelines for setting up a GraphQL server to operate over HTTP.
5+
<p className="learn-subtitle">Respond to GraphQL requests using an HTTP server</p>
6+
7+
The GraphQL specification doesn't require paricular client-server protocols when sending API requests and responses, but HTTP is the most common choice because of its ubiquity. On this page, we'll review some key guidelines to follow when setting up a GraphQL server to operate over HTTP.
8+
9+
Note that the guidelines that follow only apply to stateless query and mutation operations. Visit the [Subscriptions page](/learn/subscriptions) for more information on transport protocols that commonly support these requests.
10+
11+
<Callout type="info">
12+
The recommendations on this page align with the detailed [GraphQL-over-HTTP specification](https://graphql.github.io/graphql-over-http/draft/) currently in development. Though not yet finalized, this draft specification acts as a single source of truth for GraphQL client and library maintainers, detailing how to expose and consume a GraphQL API using an HTTP transport. Unlike the language specification, adherence is not mandatory, but most implementations are moving towards these standards to maximize interoperability.
13+
</Callout>
14+
15+
## API endpoint
16+
17+
HTTP is commonly associated with REST, which uses "resources" as its core concept. In contrast, GraphQL's conceptual model is an [entity graph](/learn/thinking-in-graphs/). As a result, entities in GraphQL are not identified by URLs. Instead, a GraphQL server operates on a single URL/endpoint, usually `/graphql`, and all GraphQL requests for a given service should be directed to this endpoint.
18+
19+
## Where auth happens
20+
21+
Most modern web frameworks use a pipeline model where requests are passed through a stack of _middleware_, also known as _filters_ or _plugins_. As the request flows through the pipeline, it can be inspected, transformed, modified, or terminated with a response. GraphQL should be placed after all authentication middleware so that you have access to the same session and user information you would in your other HTTP endpoint handlers.
22+
23+
After authentication, the server should not make any [authorization](/learn/authorization/) decisions about the request until GraphQL execution begins. Specifically, field-level authorization should be enforced by the business logic called from resolvers during [GraphQL's ExecuteRequest()](https://spec.graphql.org/draft/#ExecuteRequest()), allowing for a partial response to be generated if authorization-related errors are raised.
24+
25+
## Request format
426

5-
## Web Request Pipeline
27+
### Headers
628

7-
Most modern web frameworks use a pipeline model where requests are passed through a stack of middleware (AKA filters/plugins). As the request flows through the pipeline, it can be inspected, transformed, modified, or terminated with a response. GraphQL should be placed after all authentication middleware, so that you have access to the same session and user information you would in your HTTP endpoint handlers.
29+
GraphQL clients and servers should support JSON for serialization and may support other formats. Clients should also indicate what media types they support in responses using the `Accept` HTTP header. Specifically, the client should include the `application/graphql-response+json` in the `Accept` header.
830

9-
## URIs, Routes
31+
If no encoding information is included with this header, then it will be assumed to be `utf-8`. However, the server may respond with an error if a client doesn't provide the `Accept` header with a request.
32+
33+
<Callout type="info">
34+
The `application/graphql-response+json` is described in the draft GraphQL over HTTP specification. To ensure compatibility, if a client sends a request to a legacy GraphQL server before 1st January 2025, the `Accept` header should also include the `application/json` media type as follows: `application/graphql-response+json;charset=utf-8, application/json;charset=utf-8`
35+
</Callout>
36+
37+
### Methods
38+
39+
Your GraphQL HTTP server must handle the HTTP `POST` method for query and mutation operations, and may also accept the `GET` method for query operations.
40+
41+
#### `POST` request and body
42+
43+
A standard GraphQL POST request should set `application/json` for its `Content-type` header, and include a JSON-encoded body of the following form:
44+
45+
```json
46+
{
47+
"query": "...",
48+
"operationName": "...",
49+
"variables": { "myVariable": "someValue", ... },
50+
"extensions": { "myExtension": "someValue", ... }
51+
}
52+
```
1053

11-
HTTP is commonly associated with REST, which uses "resources" as its core concept. In contrast, GraphQL's conceptual model is an entity graph. As a result, entities in GraphQL are not identified by URLs. Instead, a GraphQL server operates on a single URL/endpoint, usually `/graphql`, and all GraphQL requests for a given service should be directed at this endpoint.
54+
The `query` parameter is required and will contain the source text of a GraphQL document. Note that the term `query` here is a misnomer: the document may contain any valid GraphQL operations (and associated fragments).
1255

13-
## HTTP Methods, Headers, and Body
56+
The `operationName`, `variables`, and `extensions` parameters are optional fields. `operationName` is only required if multiple operations are present in the `query` document.
1457

15-
Your GraphQL HTTP server should handle the HTTP GET and POST methods.
58+
Note that if the `Content-type` header is missing in the client's request, then the server should respond with a `4xx` status code. As with the `Accept` header, `utf-8` encoding is assumed for a request body with an `application/json` media type when this information is not explicitly provided.
1659

17-
### `GET` request
60+
#### `GET` request and parameters
1861

19-
When receiving an HTTP GET request, the GraphQL query should be specified in the "query" query string. For example, if we wanted to execute the following GraphQL query:
62+
When receiving an HTTP GET request, the GraphQL document should be provided in the `query` parameter of the query string. For example, if we wanted to execute the following GraphQL query:
2063

2164
```graphql
2265
{
@@ -34,37 +77,63 @@ http://myapi/graphql?query={me{name}}
3477

3578
Query variables can be sent as a JSON-encoded string in an additional query parameter called `variables`. If the query contains several named operations, an `operationName` query parameter can be used to control which one should be executed.
3679

37-
### `POST` request
80+
#### Choosing an HTTP method
3881

39-
A standard GraphQL POST request should use the `application/json` content type, and include a JSON-encoded body of the following form:
82+
When choosing an HTTP method for a GraphQL request, there are a few points to consider. First, support for HTTP methods other than `POST` will be at the discretion of the GraphQL server, so a client will be limited to the supported verbs.
4083

41-
```json
42-
{
43-
"query": "...",
44-
"operationName": "...",
45-
"variables": { "myVariable": "someValue", ... }
46-
}
47-
```
84+
Additionally, the `GET` HTTP method may only be used for `query` operations, so if a client requests execution of a `mutation` operation then it must use the `POST` method instead.
85+
86+
When servers do support the `GET` method for query operations, a client may be encouraged to leverage this option to facilitate HTTP caching or edge caching in a content delivery network (CDN). However, because GraphQL documents strings may be quite long for complex operations, the query parameters may exceed the limits that browsers and CDNs impose on URL lengths.
87+
88+
In these cases, a common approach is for the server to store identified GraphQL documents using a technique such as [_persisted documents_](https://github.com/graphql/graphql-over-http/pull/264), _automatic persisted queries_, or _trusted documents_. This allows the client to send a short document identifier instead of the full query text.
4889

49-
`operationName` and `variables` are optional fields. `operationName` is only required if multiple operations are present in the query.
90+
## Response format
5091

51-
## Response
92+
### Headers
5293

53-
Regardless of the method by which the query and variables were sent, the response should be returned in the body of the request in JSON format. As mentioned in the spec, a query might result in some data and some errors, and those should be returned in a JSON object of the form:
94+
The response type should be `application/graphql-response+json` but can be `application/json` to support legacy clients. The server will indicate the media type in the `Content-type` header of the response. It should also indicate the encoding, otherwise `utf-8` will be assumed.
95+
96+
### Body
97+
98+
Regardless of the HTTP method used to send the query and variables, the response should be returned in the body of the request in JSON format. As mentioned in the GraphQL specification, a query might result in some data and some errors, and those should be returned in a JSON object of the form:
5499

55100
```json
56101
{
57102
"data": { ... },
58-
"errors": [ ... ]
103+
"errors": [ ... ],
104+
"extensions": { ... }
59105
}
60106
```
61107

62-
If there were no errors returned, the `"errors"` field should not be present on the response. If no data is returned, [according to the GraphQL spec](https://spec.graphql.org/October2021/#sec-Data), the `"data"` field should only be included if no errors occurred during execution.
108+
If no errors were returned, the `errors` field must not be present in the response. If errors occurred before execution could start, the `errors` field must include these errors and the `data` field must not be present in the response. The `extensions` field is optional and information provided here will be at the discretion of the GraphQL implementation.
109+
110+
You can read more about GraphQL spec-compliant response formats on the [Response page](/learn/response/).
111+
112+
### Status Codes
113+
114+
If a response contains a `data` key and its value is not `null`, then the server should respond with a `2xx` status code for either the `application/graphql-response+json` or `application/json` media types. This is the case even if the response includes errors, since HTTP does not yet have a status code representing "partial success."
115+
116+
For validation errors that prevent the execution of a GraphQL operation, the server will typically send a `400` status code, although some legacy servers may return a `2xx` status code when the `application/json` media type is used.
117+
118+
For legacy servers that respond with the `application/json` media type, the use of `4xx` and `5xx` status codes for valid GraphQL requests that fail to execute is discouraged but may be used depending on the implementation. Because of potential ambiguities regarding the source of the server-side error, a `2xx` code should be used with this media type instead.
119+
120+
However, for responses with the `application/graphql-response+json` media type, the server will reply with a `4xx` or `5xx` status code if a valid GraphQL request fails to execute.
121+
122+
## Server implementations
123+
124+
If you use Node.js, we recommend looking at the [list of JS server implementations](/community/tools-and-libraries/?tags=javascript_server).
63125

64-
## Node
126+
You can view a [list of servers written in many other languages here](/community/tools-and-libraries/?tags=server).
65127

66-
If you are using Node.js, we recommend looking at the [list of server implementations](/code/#javascript-server).
128+
## Recap
67129

68-
## Draft Transport Specification
130+
To recap these recommendations for serving GraphQL over HTTP:
69131

70-
A detailed [HTTP transport specification](https://github.com/graphql/graphql-over-http) is in development. Though it is not yet finalized, these draft specifications act as a single source of truth for GraphQL client & library maintainers, detailing how to expose and consume a GraphQL API using an HTTP transport. Unlike the language specification, adherence is not mandatory, but most implementations are moving towards these standards to maximize interoperability.
132+
- The server should handle user authentication before a GraphQL request is validated; authorization should happen within your business logic during GraphQL request execution
133+
- GraphQL APIs are exposed at a single endpoint, typically ending with `/graphql`
134+
- GraphQL clients and servers should support JSON, but may support other formats
135+
- Client should indicate a media type on the `Accept` header of `application/graphql-response+json`
136+
- GraphQL requests are sent using the `POST` HTTP method, but query operations may also be sent using the `GET` method
137+
- Clients should also provide a `Content-type` header with a value of `application/json` for `POST` requests
138+
- The full or partial result of an executed GraphQL operation will be available on the `data` key in the JSON-encoded body of the response, while information about any errors raised during validation or execution will be available on the `errors` key
139+
- Response status codes for valid GraphQL operations that fail may vary depending on the indicated media type of the response, but any GraphQL response with a non-null `data` key will provide a `2xx` response

0 commit comments

Comments
 (0)