¿Cómo probar una API GraphQL?
- ¿Cómo probar una API GraphQL?
- Aplicación móvil API Tester, una solución para todos los problemas
- Vamos a usar la aplicación API Tester
- Cómo generar una clave de acceso al token de la API de GitHub
- Continuemos creando la solicitud
- Consejos para probar
- ¿Por qué la aplicación móvil API Tester?
¿Qué es GraphQL?
Si no lo sabes, GraphQL es un lenguaje de consulta para APIs que desarrolló Facebook. Te permite solicitar datos de una API de manera declarativa, lo que facilita trabajar con estructuras de datos complejas.
GraphQL proporciona un tiempo de ejecución del lado del servidor para ejecutar consultas usando un sistema de tipos que defines para tus datos. GraphQL es compatible con tu código y datos actuales, en lugar de depender de una base de datos o motor de almacenamiento específico.
Se definen tipos y campos en esos tipos, y luego se proporcionan funciones para cada campo en cada tipo para establecer un servicio GraphQL.
GraphQL está ganando popularidad y muchos desarrolladores buscan aprender a usarlo. En esta guía, repasaremos algunos de los conceptos básicos de GraphQL y cómo puedes probar tu API GraphQL.
¿Por qué usarlo?
Entonces, ¿por qué usar GraphQL?
Hay varias razones:
- Simplicidad: GraphQL está diseñado para facilitar la obtención de los datos que necesitas en una sola solicitud. Esto significa menos código en general, lo cual siempre es algo bueno.
- Eficiencia: Con GraphQL, puedes especificar los datos que necesitas en tu solicitud. Esto significa que el servidor no tiene que enviar datos adicionales que no necesitas, haciendo que tus solicitudes sean más eficientes.
- Flexibilidad: GraphQL es lo suficientemente flexible como para usarse con cualquier tipo de datos, desde datos simples como cadenas y números hasta datos más complejos como imágenes y archivos.
En general, GraphQL es una herramienta poderosa que puede hacer tu vida más fácil como desarrollador. Así que si estás trabajando con APIs, ¡definitivamente dale una oportunidad!
¿Qué vale la pena considerar?
Ahora que sabes qué es GraphQL y por qué es importante, es hora de aprender en qué debes prestar atención al probar una API GraphQL. Hay algunas cosas diferentes que querrás tener en cuenta:
- Los tipos de datos de los campos: ¿Son del tipo de datos correcto?
- La estructura de los datos: ¿Están los datos en el orden correcto?
- Las relaciones entre tipos: ¿Se están devolviendo las relaciones correctas?
- Los permisos: ¿Se están devolviendo los datos solo a quienes tienen permiso para verlos?
Las APIs GraphQL se utilizan para asegurar que las consultas, ajustes y esquemas hechos para una aplicación funcionen como se espera en el frontend.
Estos son solo algunos de los factores que querrás tener en cuenta al probar una API GraphQL. Al mantener estos factores en mente, puedes asegurarte de que tu API esté funcionando correctamente y que tus datos estén seguros.
¿Cómo probar una API GraphQL?
Ahora que hemos repasado algunos de los conceptos básicos de las pruebas de APIs GraphQL, hablemos de algunas de las herramientas que puedes usar para hacer tu vida un poco más fácil.
Puedes hacer algunas cosas diferentes en la PC para probar tu API GraphQL.
Primero, puedes usar una herramienta de prueba de terceros como GraphiQL. Esta es una excelente opción para probar tu API sin escribir ningún código.
Otra opción es usar una herramienta como Postman. Con esta herramienta, puedes enviar solicitudes HTTP a tu API y obtener respuestas. Esta es una excelente opción si quieres probar una funcionalidad específica en tu API.
También puedes usar una herramienta como SoapUI. Esta herramienta te permite probar tanto APIs SOAP como REST. Esta es una excelente opción si quieres probar tu API con ambas solicitudes.
Las herramientas de prueba funcional de GraphQL más populares para desarrolladores de JavaScript te permiten probar rápidamente las afirmaciones para confirmar las respuestas de la API como parte de un conjunto de pruebas automatizadas integrando con una herramienta como Mocha.
Hay algunas opciones diferentes para los usuarios de PC, como GraphQL CLI. Es una interfaz de línea de comandos que te permite generar automáticamente pruebas para tu esquema y es muy fácil de usar.
Otra excelente opción es el Apollo Server playground. Esta es una interfaz gráfica que te permite interactuar con tu API de una manera fácil de usar.
Estas herramientas son excelentes para probar APIs GraphQL, por lo que todo se reduce a la preferencia personal. Se usan en PC, pero hay una novedad a continuación para hacer que tus pruebas y eficiencia de trabajo sean rápidas.
Aplicación móvil API Tester, una solución para todos los problemas
En la lucha por probar tus APIs usando tu teléfono, entra en escena la aplicación móvil API Tester. Te proporcionará una experiencia optimizada para móviles y sin complicaciones para tu trabajo en curso.
Tiene todas las herramientas que necesitas para usarlas. Puedes ejecutar cualquier prueba usando su editor avanzado y entorno de pruebas API.
Tu laptop ya no es necesaria para el uso diario. Depuración y prueba de tu API pueden hacerse rápidamente y en cualquier lugar. Soporta el entorno de pruebas GraphQL y todos los métodos efectivos, gets y posts.
Puedes descargar la aplicación móvil API Tester en tu iPhone, iPad o dispositivo Android. Ve a apitester.org o busca en Play Store/App Store, API Tester en el primer resultado que veas y descárgala.
Después del desarrollo de la API, ¿quieres probar tus consultas GraphQL en una aplicación móvil? A continuación, verás cómo usar API Tester para hacerlo.
Vamos a explicar cómo usar API Tester para probar tus consultas GraphQL en una aplicación móvil.
Vamos a usar la aplicación API Tester
Voy a usar la API de GitHub para demostrar cómo trabajar con la aplicación API Tester. Nos proporciona datos en tiempo real.
Haz clic en “crear nueva solicitud” o el botón + en la esquina superior derecha para iniciar una solicitud GraphQL.
Puedes verlo en las capturas de pantalla adjuntas.
Puedes ver fácilmente la opción GraphQL en la nueva pestaña bajo otras características. Al hacer clic en ella, te llevará a más opciones.
En la siguiente pantalla, puedes ver una solicitud GraphQL sin título.
La primera pestaña muestra el nombre de la solicitud. Puedes cambiarle el nombre (lo cual es una buena práctica para que no te confundas cuando hay muchas solicitudes).
También necesitas proporcionar la URL de la API y pegarla en la sección que empieza con HTTPS.
Puedes ver múltiples opciones para GraphQL abajo, como Cuerpo, Variables, Encabezados, Documentos y Configuraciones.
Voy a usar la API de GitHub, así que pondré api.github.com/graphql en la sección de URL.
Cuando ejecutes esto ahora, verás que este endpoint requiere que estés autenticado, por lo que necesitas proporcionar la información de autenticación y dirigirte a la solicitud.
En la sección de Encabezados, puedes ver la opción OAuth, así que necesitas proporcionar el token de acceso aquí. Puedes generarlo desde GitHub. Usaré mi token para la explicación y lo proporcionaré en el campo correspondiente.
Cómo generar una clave de acceso al token de la API de GitHub
Para generar una clave, primero ve a github.com e inicia sesión en tu cuenta usando tus credenciales y luego Haz clic en tu avatar de perfil en la esquina superior derecha y selecciona Configuraciones.
Al final, puedes ver otra opción conocida como Configuraciones de desarrollador. Haz clic en esa opción y avanza.
Aquí se ven tres opciones. Selecciona la opción token de acceso personal y haz clic en generar nuevo token (clásico).
En la sección de notas, escribe el nombre del token para recordarlo. Luego selecciona la fecha de vencimiento del token.
En las opciones adicionales, selecciona el alcance de los tokens para el propósito de acceso OAuth, lo que deseas permitir acceso o no.
Después de completar estas configuraciones, haz clic en el botón en la parte inferior Generar token.
¡Felicidades, nuestro token está generado! Podemos usarlo para tus pruebas de API en la aplicación para el propósito de pruebas GraphQL.
Continuemos creando la solicitud
Pegaré el token creado en la sección OAuth como mencioné anteriormente.
Ahora tenemos que ir a la sección de Cuerpo y especificar una consulta para obtener tu tipo específico de datos. Por ejemplo, obtengamos la información del id de una cuenta de GitHub. Entonces, la consulta correspondiente usando el inicio de sesión de GitHub se escribe en la pestaña de cuerpo, como puedes ver en la captura de pantalla a continuación.
Si ejecutas esto ahora, verás que obtienes el inicio de sesión y el id del perfil de GitHub.
Además, si deseas obtener una URL, biografía o cualquier otra información disponible, debes proporcionarla en la sección de cuerpo como una consulta.
En la sección de Documentos, puedes ver las consultas y mutaciones. Te ayudarán a ejecutar una solicitud explícita.
Consejos para probar
Ahora que conoces los conceptos básicos de las pruebas de GraphQL en Mobile API Tester, aquí hay algunos consejos para tener en cuenta:
- Primero, asegúrate de estar usando la versión más reciente del esquema GraphQL. Si no lo estás, actualiza tu esquema y vuelve a ejecutar tus pruebas.
- Segundo, revisa tus resolvers. Asegúrate de que están resolviendo correctamente los datos que estás consultando.
- Tercero, asegúrate de que tu servidor GraphQL esté funcionando y accesible. Puedes hacerlo revisando los registros del servidor.
- Cuarto, si estás usando un servidor GraphQL simulado, asegúrate de que los datos simulados sean correctos.
- Al crear pruebas, siempre comienza con las consultas más simples posibles y agrega complejidad gradualmente. Esto te ayudará a identificar problemas más rápidamente.
- Presta atención a la estructura de tus consultas y asegúrate de que estén bien formadas. Esto incluye usar la capitalización y la indentación adecuadas.
- Utiliza el "modo de depuración" en Mobile API Tester para ver exactamente qué se envía con cada solicitud. Esto puede ser útil para fines de resolución de problemas.
- Mantén tus pruebas organizadas creando proyectos separados para cada tipo de prueba (por ejemplo, unitarias vs. integración). Esto hará que sea más fácil encontrar lo que buscas más adelante.
Siguiendo estos consejos, deberías poder probar GraphQL en Mobile API Tester sin problemas.
¿Por qué la aplicación móvil API Tester?
- Tiene una interfaz simple y fácil de usar que facilita la prueba de tus APIs.
- La aplicación proporciona retroalimentación en tiempo real para que puedas ver cómo están funcionando tus APIs en uso real.
- Es rápida y eficiente, por lo que puedes probar rápidamente múltiples APIs.
La aplicación móvil API Tester ha sido específicamente diseñada para ayudar a los desarrolladores a probar sus APIs.
La aplicación proporciona varias características que facilitan simular la interacción real del usuario con tus APIs.
Por ejemplo, puedes generar solicitudes y respuestas, ver registros y rastrear interacciones del usuario. La aplicación también tiene un depurador integrado que facilita explorar cualquier error durante el proceso de prueba.
Conclusión
En este artículo, discutimos cómo probar una API GraphQL usando la aplicación móvil API Tester. Esta es una herramienta imprescindible si trabajas con APIs. Puede ayudarte a solucionar problemas. La aplicación proporciona una rica retroalimentación para que siempre sepas lo que está sucediendo con tus solicitudes y respuestas en cualquier parte del mundo.
Jorge García
Fullstack developer