Cómo probar una API GraphQL en VS Code
En esta página 6 secciones
Respuesta corta: una solicitud GraphQL es un POST HTTP con un cuerpo JSON que contiene la consulta, sus variables y, opcionalmente, un nombre de operación. Cualquier cliente REST que entienda GraphQL puede enviarla. Esta guía usa el cliente de API REST gratuito de DevSnip Pro, que tiene un modo GraphQL con campos separados para la consulta, las variables y el nombre de la operación.
- Ejecuta DevSnip Pro: REST API Client desde la Paleta de comandos (Ctrl/Cmd+Shift+P).
- Cambia el protocolo de HTTP a GraphQL (junto al nombre de la solicitud). La pestaña Body se sustituye por una pestaña Query.
- Establece el método en POST e introduce el endpoint, por ejemplo
https:/(una API pública de demostración) o/ countries. trevorblades. com/ {{baseUrl}}/.graphql
Si el método es GET, el cliente avisa de que la consulta no se enviará y ofrece Use POST.
En el campo Query:
query GetCountry($code: ID!) {
country(code: $code) {
name
capital
currency
}
}En Variables (JSON):
{ "code": "DE" }El campo de variables se comprueba mientras escribes, así que el JSON no válido se señala antes de enviarlo. Rellena Operation name (GetCountry) cuando el documento contenga más de una operación.
Pulsa Ctrl/Cmd+Enter o Send. Los servidores GraphQL suelen responder 200 OK aunque la consulta falle, así que lee el cuerpo:
datacontiene el resultado;errorsenumera los problemas con un mensaje y una ruta. Una respuesta puede contener ambos, lo que significa un resultado parcial.
Las APIs GraphQL usan la misma autenticación que las REST. Pon el token en una variable de entorno y configura la autenticación Bearer como {{token}}; cambia de entorno para ejecutar la misma consulta en local y en staging. Guarda la solicitud en una colección para que la consulta sirva de documentación.
Abre GraphQL Formatter & Types desde la sección Backend & API de la barra lateral de herramientas:
- Query: format & request formatea o minifica una consulta, enumera sus operaciones y variables, y genera el cuerpo JSON de la solicitud, un comando cURL y una llamada
fetch. Señala fragmentos no definidos o sin usar y operaciones sin nombre. - Schema (SDL) → TypeScript convierte un esquema en tipos de TypeScript. Para operaciones totalmente tipadas, GraphQL Code Generator va más allá.
- No hay explorador de esquemas ni autocompletado basado en introspección; escribe la consulta tú mismo o pégala desde tu código.
- Las suscripciones GraphQL sobre WebSocket no tienen un modo propio. La herramienta WebSocket del cliente es una función avanzada que cuesta puntos.