apollo-server/docs/source/requests.md

53 lines
1.7 KiB
Markdown
Raw Normal View History

2017-07-20 17:34:51 -04:00
---
title: POST and GET format
description: How to send requests to Apollo Server over HTTP.
2017-07-20 17:34:51 -04:00
---
2017-07-20 17:37:44 -04:00
Apollo Server accepts both GET and POST requests.
2017-07-20 17:34:51 -04:00
<h2 id="postRequests">POST requests</h2>
2017-07-20 17:37:44 -04:00
Apollo Server accepts POST requests with a JSON body. A valid request must contain either a `query` or an `operationName` (or both, in case of a named query), and may include `variables.` Here's an example for a valid body of a post request:
2017-07-20 17:34:51 -04:00
```js
{
"query": "query aTest($arg1: String!) { test(who: $arg1) }",
"operationName": "aTest",
"variables": { "arg1": "me" }
}
```
Variables can be an object or a JSON-encoded string. I.e. the following is equivalent to the previous query:
```js
{
"query": "query aTest($arg1: String!) { test(who: $arg1) }",
"operationName": "aTest",
"variables": "{ \"arg1\": \"me\" }"
}
```
2017-07-24 00:11:14 -07:00
<h3 id="batching">Batching</h3>
2017-07-20 17:34:51 -04:00
A batch of queries can be sent by simply sending a JSON-encoded array of queries, e.g.
```js
[{ query: '{ testString }' }, { query: 'query q2{ test(who: "you" ) }' }];
2017-07-20 17:34:51 -04:00
```
If a batch of queries is sent, the response will be an array of GraphQL responses.
2017-07-20 17:37:44 -04:00
If Apollo Server is running under a different origin than your client, you will need to enable CORS support on the server, or proxy the GraphQL requests through a web server under the main origin.
2017-07-20 17:34:51 -04:00
<h2 id="getRequests">GET requests</h2>
2017-07-20 17:37:44 -04:00
Apollo Server also accepts GET requests. A GET request must pass query and optionally variables and operationName in the URL.
2017-07-20 17:34:51 -04:00
2017-07-20 17:37:44 -04:00
Here is the same query from above in a well-formatted GET request to Apollo Server:
2017-07-20 17:34:51 -04:00
```
GET /graphql?query=query%20aTest(%24arg1%3A%20String!)%20%7B%20test(who%3A%20%24arg1)%20%7D&operationName=aTest&variables=me
```
caveat: Mutations cannot be executed via GET requests.