Graphql学习(五)-Http请求规范

﹏ヽ暗。殇╰゛Y 2021-06-24 16:09 509阅读 0赞

GraphQL HTTP 服务器一般都可以处理 HTTP 的 POST 方法，有的还可以处理 GET 方法。

1.  GET 请求

用 GET 请求查询 GraphQL 服务器时，应当将查询的文档，变量和操作名称作为 GET 参数传给服务器。  
完整的参数格式：?query=查询文档&variables=变量&operationName=操作名称。

query：查询文档，必填。  
variables：变量，选填。  
operationName：操作名称，选填，查询文档有多个操作时必填。  
// 请求

<table> 
 <tbody> 
  <tr> 
   <td> <pre><code>1
2
3
4
</code></pre> </td> 
   <td> <pre><code>  viewer {
    name
  }
}
</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

对应的通过 HTTP GET 发送的示例：  
[http://api.com/graphql?query=\{viewer\{name\}\}][http_api.com_graphql_query_viewer_name]

1.  POST 请求

标准的 GraphQL POST 请求应当在 HTTP header 中声明 Content-Type: application/json，并且使用 JSON 格式的内容。  
POST 报文体中的 JSON 数据中的三个字段跟 GET 请求类似：

query：查询文档，必填。  
variables：变量，选填。  
operationName：操作名称，选填，查询文档有多个操作时必填。

<table> 
 <tbody> 
  <tr> 
   <td> <pre><code>1
2
3
4
5
</code></pre> </td> 
   <td> <pre><code>{
  "query": "{viewer{name}}",
  "operationName": "",
  "variables": { "name": "value", ... }
}
</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

1.  响应

无论用 GET 还是 POST 方法查询，HttpStatus均为200，响应一般都会以 JSON 格式在 POST 的报文体返回。响应的规范参考这里，正常响应的数据放在 data 属性中，异常时记录在 errors 属性中：

<table> 
 <tbody> 
  <tr> 
   <td> <pre><code>1
2
3
4
</code></pre> </td> 
   <td> <pre><code>{
  "data": { ... },
  "errors": [ ... ]
}</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

[http_api.com_graphql_query_viewer_name]: http://api.com/graphql?query=%7Bviewer%7Bname%7D%7D