Enviar requests
Requests GraphQL
Cómo escribir una consulta GraphQL con sus variables y qué envía Luvin al servidor.
Un request GraphQL envía una consulta (query) o una mutación a un endpoint GraphQL. Úsalo cuando la API que pruebas habla GraphQL en lugar de REST.
Ejemplo
Sección titulada «Ejemplo»Una API GraphQL pública de países. Crea un request GraphQL, escribe la URL https://countries.trevorblades.com/graphql y esto en la pestaña Query:
query Country($code: ID!) { country(code: $code) { name capital currency }}En Variables:
{ "code": "CL"}Pulsa Enviar. El status es 200 OK y el Body es:
{"data":{"country":{"capital":"Santiago","currency":"CLF,CLP","name":"Chile"}}}Crear un request GraphQL
Sección titulada «Crear un request GraphQL»- En la barra lateral, haz clic en Nuevo request debajo de tu colección.
- En el diálogo Nuevo request, elige GraphQL.
- El request se abre con el nombre Nueva consulta GraphQL. En la barra lateral tiene una insignia GQL.
Escribir la consulta
Sección titulada «Escribir la consulta»- Escribe la URL del endpoint GraphQL, por ejemplo
https://api.example.com/graphql. - En la pestaña Query, escribe la consulta o la mutación.
- En la pestaña Variables, escribe las variables como JSON.
- Pulsa Enviar (⌘/Ctrl + Enter). La respuesta aparece debajo, igual que en cualquier request HTTP.
Una consulta con una variable:
query Country($code: ID!) { country(code: $code) { name capital currency }}Y sus variables:
{ "code": "CL"}La pantalla del request tiene cuatro pestañas:
| Pestaña | Qué contiene |
|---|---|
| Query | La consulta o la mutación. |
| Variables | Un objeto JSON con las variables de la consulta. Un request nuevo empieza con {}. |
| Headers | La misma tabla que en un request HTTP, con los headers automáticos. |
| Autorización | Las mismas opciones que en un request HTTP. Un request GraphQL nuevo hereda la autorización de la colección. |
No hay pestaña Params ni pestaña Body: el body se arma a partir de la consulta y las variables.
Qué envía Luvin
Sección titulada «Qué envía Luvin»Luvin envía un POST a la URL, con un body JSON que contiene la consulta y las variables:
{ "query": "query Country($code: ID!) { country(code: $code) { name capital currency } }", "variables": { "code": "CL" }}- El header
Content-Typeesapplication/json, salvo que escribas el tuyo en Headers. - Si la pestaña Variables está vacía, el body no lleva
variables. - Las
{{variables}}del ambiente y los generadores se reemplazan en la URL, la consulta, las variables y los headers antes de enviar.
Para ver exactamente qué salió, abre Request enviado en la respuesta.
Leer la respuesta
Sección titulada «Leer la respuesta»El área de la respuesta es la misma que en un request HTTP: status, tiempo y tamaño, y luego Body, Headers, Cookies y Request enviado.
Límites
Sección titulada «Límites»- Un request GraphQL no se puede arrastrar a un workflow como paso. Solo los requests HTTP pueden.
- Pegar un comando cURL en el campo de la URL no lo convierte. Usa un request HTTP para eso.