Compartir a través de

Fabric API for GraphQL schema view and schema explorer (API de Fabric para GraphQL schema view and schema explorer)

El esquema GraphQL, basado en el lenguaje de definición de esquemas (SDL) de GraphQL, define el formato de los datos expuestos en la API. Proporciona flexibilidad a los consumidores al ocultar los detalles de implementación de back-end. El esquema usa una colección de tipos de objeto que contienen campos.

Vista de esquema

Para acceder a la vista de esquema, seleccione Esquema en la esquina inferior izquierda de la pantalla Desarrollo de datos. Esta vista muestra una versión basada en texto del SDL de GraphQL con tipos, campos y operaciones generados.

En la imagen siguiente se muestra un ejemplo de la vista de esquema, incluida una lista de objetos disponibles en este esquema.

Nota:

La vista de esquema es de solo lectura. Modifique los objetos solo en el Explorador de esquemas.

Captura de pantalla de la pantalla de vista de esquema de API, que incluye el Explorador de esquemas en el panel izquierdo.

Explorador de esquemas

El Explorador de esquemas se encuentra en el panel de la izquierda y también está disponible cuando se usa el editor en la vista de consulta. El explorador permite a los usuarios visualizar rápidamente los tipos y campos disponibles, así como consultas y mutaciones, definidos en la API.

Todos los tipos de GraphQL disponibles en los objetos que elija al conectarse a un origen de datos aparecen en la lista Explorador de esquemas. Los tipos aparecen bajo el nombre del origen de datos desde el que se derivaron. En la imagen siguiente se muestra el tipo SalesOrderDetail derivado de la tabla SalesOrderDetail en el punto de análisis SQL de AdventureWorks.

Captura de pantalla del panel Explorador de esquemas que muestra la lista expandida de tipos disponibles en un origen de datos de ejemplo denominado SalesOrderDetail.

Además de los tipos, Fabric API for GraphQL genera automáticamente consultas y mutaciones para los nuevos objetos que elija exponer.

En nuestro ejemplo de AdventureWorks, al expandir la lista de consultas se muestran las consultas generadas automáticamente para el origen de datos.

Captura de pantalla del panel Explorador de esquemas, en la que se muestra una lista expandida de consultas generadas automáticamente.

Expanda el nodo de mutaciones en el árbol explorador de esquemas para ver las mutaciones generadas automáticamente por la API.

Captura de pantalla del panel Explorador de esquemas, en la que se muestra una lista expandida de mutaciones generadas automáticamente.

Modificación de objetos mediante el explorador de esquemas

Puede utilizar el Explorador de esquemas para modificar objetos después de que la API los cree. En el ejemplo siguiente, seleccionamos los puntos suspensivos junto al tipo SalesOrderDetail derivado de nuestra base de datos AdventureWorks:

Captura de pantalla del explorador de esquemas con los puntos suspensivos seleccionados, en la que se muestran las opciones de menú disponibles.

Las siguientes opciones están disponibles para Types:

  • Actualizar esquema : permite actualizar el esquema con nuevos objetos del origen de datos.

  • Cambiar nombre: cambia el nombre del objeto. Este cambio solo afecta al esquema de API y no afecta al objeto de origen de datos original del que se deriva.

  • Quitar del esquema : elimina el objeto del esquema GraphQL, por lo que ya no se puede hacer referencia a él.

  • Administrar relaciones : abre la experiencia de administración de relaciones. Para más información, consulte Administrar relaciones en la API de Fabric para GraphQL.

  • Propiedades: muestra información adicional sobre el objeto.

Habilitación y deshabilitación de consultas y mutaciones

La característica habilitar o deshabilitar para consultas y mutaciones proporciona a los administradores y desarrolladores un control pormenorizado sobre el acceso y el uso de la API. Permite activar o desactivar de forma selectiva consultas y mutaciones específicas dentro del esquema GraphQL. Esto te permite administrar las funcionalidades de API dinámicamente sin modificar el código ni implementar los cambios.

Las consultas y las mutaciones en el explorador de esquemas tienen otras dos opciones:

  • Deshabilitar: impide que las solicitudes ejecuten la consulta o la mutación. Si se intenta ejecutar, se devuelve un error. Después de deshabilitar una consulta o mutación, se produce una recarga de esquema y la consulta o mutación aparece atenuada en el explorador de esquemas.

Captura de pantalla de la opción deshabilitar la consulta o la mutación que se muestra en el explorador de esquemas.

  • Habilitar: permite volver a habilitar una consulta o una mutación deshabilitadas anteriormente. La consulta o mutación está disponible inmediatamente después de la operación de recarga de esquema que se produce al seleccionar la opción Habilitar .

Captura de pantalla de la opción habilitar la consulta de mutación que se muestra en el explorador de esquemas.

Las consultas o mutaciones generadas automáticamente a partir de procedimientos almacenados solo se pueden eliminar. Después de la eliminación, se pueden leer mediante las opciones Obtener datos o Actualizar esquema .

Contenido relacionado

  • Last updated on