Importación de GraphQL API (versión preliminar)

  • Artículo
  • 3 minutos para leer

GraphQL es un lenguaje de consulta estándar del sector de código abierto para las API. A diferencia de las API basadas en puntos de conexión (o estilo REST) diseñadas en torno a acciones sobre recursos, las GraphQL API admiten un conjunto más amplio de casos de uso y se centran en tipos de datos, esquemas y consultas.

API Management aborda los desafíos de seguridad, autenticación y autorización que se conlleva la publicación de GraphQL API. Con API Management para exponer las GraphQL API, puede hacer lo siguiente:

  • Agregar un servicio de GraphQL como API a través de Azure Portal.
  • Proteger las GraphQL API mediante la aplicación de directivas de control de acceso existentes y una nueva directiva para protegerse frente a ataques específicos de GraphQL.
  • Explore el esquema y ejecute consultas de prueba en las GraphQL API en los portales de Azure y para desarrolladores.

Importante

Actualmente la API de GraphQL de API Management se encuentra en versión preliminar.

En este artículo, hará lo siguiente:

  • Obtener más información sobre las ventajas de usar las GraphQL API.
  • Agregar una GraphQL API a la instancia de API Management.
  • Probar la GraphQL API.
  • Conocer las limitaciones de GraphQL API en API Management.

Requisitos previos

Agregar una GraphQL API

  1. Navegue hasta su instancia de API Management.

  2. En el menú de navegación lateral, en la sección API, seleccione API.

  3. En Definir una API nueva, seleccione el icono GraphQL.

    Selección del icono GraphQL de la lista de API

  4. En el cuadro de diálogo, seleccione Completo y rellene los campos necesarios del formulario.

    Mostrar campos para crear GraphQL

    Campo Descripción
    Nombre para mostrar Nombre con el que se mostrará la GraphQL API.
    Nombre Nombre sin formato de la GraphQL API. Se rellena automáticamente a medida que escribe el nombre para mostrar.
    Punto de conexión de la GraphQL API Dirección URL base con el nombre del punto de conexión de la GraphQL API.
    Por ejemplo: https://example.com/your-GraphQL-name . También puede usar el punto de conexión común de GraphQL "Star Wars" como demo.
    Cargue el archivo de esquema Seleccione esta opción para examinar y cargar el archivo de esquema.
    Descripción Agregue una descripción de la API.
    Esquema URL Seleccione HTTP, HTTPS o Ambos. Selección predeterminada: Ambos.
    Sufijo de dirección URL de API Agregue un sufijo de URL para identificar esta API específica en esta instancia de API Management. Tiene que ser único en esta instancia de API Management.
    URL base Campo no editable que muestra la dirección URL base de la API
    Etiquetas Asocie la GraphQL API a etiquetas nuevas o existentes.
    Productos Asocie la GraphQL API a un producto para publicarla.
    Puertas de enlace Asocie la GraphQL API a las puertas de enlace existentes. Selección de puerta de enlace predeterminada: Administrada.
    ¿Definir versión de esta API? Seleccione esta opción para controlar la versión de la GraphQL API.

  5. Haga clic en Crear.

Probar la GraphQL API

  1. Navegue hasta su instancia de API Management.

  2. En el menú de navegación lateral, en la sección API, seleccione API.

  3. En Todas las API, seleccione la GraphQL API.

  4. Seleccione la pestaña Prueba para acceder a la consola Prueba.

  5. En Encabezados:

    1. Seleccione el encabezado en el menú desplegable Nombre.
    2. Escriba el valor en el campo Valor.
    3. Agregue más encabezados seleccionando + Agregar encabezado.
    4. Elimine los encabezados mediante el icono de la papelera.

  6. Si ha agregado un producto a la GraphQL API, aplique el ámbito del producto en Aplicar ámbito del producto.

  7. En el Editor de consultas, haga una de las opciones siguientes:

    1. Seleccione al menos un campo o subcampo de la lista en el menú lateral. Los campos y subcampos que seleccione aparecerán en el editor de consultas.

    2. Comience a escribir en el editor de consultas para crear una consulta.

      Demostración de la adición de campos al editor de consultas

  8. En Variables de consulta, agregue variables para reutilizar la misma consulta o mutación y pasar valores diferentes.

  9. Haga clic en Enviar.

  10. Vea la Respuesta.

    Visualización de la respuesta de la consulta de prueba

  11. Repita los pasos anteriores para probar diferentes cargas.

  12. Una vez completadas las pruebas, salga de la consola de prueba.

Limitaciones

  • Solo se admite el paso a través de GraphQL.
  • Una única GraphQL API en API Management corresponde solo a un único punto de conexión de back-end de GraphQL.

Pasos siguientes

Transformación y protección de una API publicada