Vista de esquema y explorador de esquemas de la API de Fabric para GraphQL
El esquema de GraphQL, que se basa en el lenguaje de definición de esquemas (SDL) de GraphQL, define el formato de los datos expuestos en la API. Es una capa de abstracción que proporciona flexibilidad a los consumidores y, al mismo tiempo, oculta los detalles de implementación de back-end. El esquema se basa en 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. La vista muestra una versión basada en texto del SDL de GraphQL con tipos, campos y operaciones generados.
La imagen siguiente es un ejemplo de la vista de esquema, incluida una lista extensa de objetos disponibles en este esquema.
Nota:
La vista de esquema es de solo lectura. Solo puede modificar objetos en el Explorador de esquemas.
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 que están 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, verá el tipo SalesOrderDetail derivado de la tabla SalesOrderDetail en el punto de conexión de Análisis SQL de AdventureWorks.
Además de los tipos, la API de Fabric para 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.
Para ver las mutaciones generadas de forma automática por la API, expanda el nodo de mutaciones en el árbol del Explorador de esquemas.
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:
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. NOTA: Este cambio solo afecta al esquema de API y no tiene ningún efecto en el objeto de origen de datos original del que se ha derivado.
- Quitar del esquema: elimina eficazmente el objeto del esquema GraphQL para que ya no pueda hacer referencia a él.
- Administrar relaciones: le lleva a 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/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 dos opciones adicionales:
- Deshabilitar: impide que las solicitudes ejecuten la consulta o la mutación. Si se intenta ejecutar, se devuelve un error. Una vez deshabilitada una consulta o una mutación, se produce una recarga de esquema y la consulta o mutación aparece atenuada en el explorador de esquemas.
- Habilitar: vuelve a habilitar una consulta o una mutación deshabilitadas previamente. La ejecución del elemento está disponible inmediatamente tras la operación de recarga de esquema que tiene lugar después de seleccionar la opción Habilitar.
Ten en cuenta que las consultas o mutaciones generadas automáticamente a partir de procedimientos almacenados solo se pueden eliminar. Una vez eliminados, se pueden volver a agregar mediante las opciones Obtener datos o Actualizar esquema.