Prueba de una API GraphQL con la pestaña Probar

Para una definición de API GraphQL, la pestaña Probar contiene un editor GraphiQL. Puede utilizar el editor GraphiQL para facilitar la construcción de una consulta de GraphQL. Al probar la API GraphQL, la respuesta se visualiza en el editor GraphiQL.

Puede probar una consulta de GraphQL de las formas siguientes:

Para cada tipo de operación, puede probar la consulta con respecto al propio punto final de API GraphQL o con respecto al punto final de coste, que devuelve detalles del coste de una solicitud al punto final de API GraphQL.

Sea cual sea el método y el punto final que utilice, puede suministrar la consulta directamente o utilizar el editor GraphiQL para facilitar la construcción de la consulta; el editor proporciona asistencia de tecleo anticipado basado en el esquema definido para la API y resalta los errores junto con sugerencias de corrección. El esquema se cargó inicialmente al crear la definición de la API GraphQL, pero puede haberse modificado posteriormente. Para obtener detalles sobre la creación de una definición de API GraphQL , consulte Creación de una API de proxy GraphQL. Para obtener detalles sobre cómo modificar el esquema, consulte Utilización del editor de esquemas de GraphQL.

Antes de empezar

Consulte Preparación de una API para la depuración con el separador Probar para conocer los requisitos que debe cumplir la definición de API para que pueda probarla con el separador Probar.

Procedimiento

1. En la sección Solicitar, seleccione el tipo de operación y el punto final necesarios; por ejemplo:
   • POST https://myserver.com/myorg/sandbox/mybasepath/graphql
   • GET https://myserver.com/myorg/sandbox/mybasepath/graphql/cost
2. En la pestaña GraphiQL del panel izquierdo del editor, especifique la consulta; por ejemplo:

   {
     accounts(limit: 100) {
       name {
         first
         last
       }
     }
   }

3. Si es necesario, puede especificar cabeceras de solicitud adicionales en la pestaña Parámetros.
4. Si la consulta incluye variables, puede especificar valores para las variables en el panel Variables de consulta. Por ejemplo, si la consulta es la siguiente:

   query MyQuery($Query__accounts__limit: Int)
   {
     accounts(limit: $Query__accounts__limit) {
       name {
         first
         last
       }
     }
   }

   puede definir un valor para Query__accounts__limit especificando lo siguiente en el panel Variables de consulta:

   {
     "Query__accounts__limit": variable_value
   }

   donde valor_variable es el valor necesario.
5. Pulse Enviaro el icono Ejecutar consulta en el editor. La respuesta se visualizará en el editor GraphiQL y la sección Rastreo mostrará cómo se ha ejecutado la llamada de API. Para obtener detalles sobre la información de rastreo, consulte Examinar el rastreo.