Novedades de Data API Builder, versión 1.3 (noviembre de 2024)

Notas de la versión e información sobre las actualizaciones y mejoras de Data API Builder (DAB) versión 1.3.
Versión 1.3: Generador de API de datos para bases de datos de Azure

Presentación: Recarga instantánea

El bucle de desarrollador ahora es más pequeño, más rápido y eficaz. Anteriormente, cambiar el archivo de configuración era necesario para detener y reiniciar el motor. Con recarga activa, DAB detecta automáticamente los cambios de configuración y aplica actualizaciones sin reiniciar el motor. Puede probar los cambios de forma instantánea y permanecer en el flujo. A partir de la versión 1.3, casi todas las características DAB admiten recarga en caliente.

Hot Reload siempre está activado y no se puede deshabilitar. Sin embargo, en el modo production, no aplica cambios de configuración. Este comportamiento impide que las actualizaciones no autorizadas vuelvan a configurar de forma silenciosa los puntos de conexión. En una versión futura, production el modo también admite la log-level configuración, una característica que ajusta el detalle del registro por espacio de nombres para facilitar el diagnóstico del comportamiento en tiempo de ejecución.

Presentación: Generación de esquemas de Cosmos

Data API Builder es una de las primeras interfaces de línea de comandos (CLIs) para ayudar a los desarrolladores a generar esquemas para orígenes de datos NoSQL. Al configurar Cosmos DB, DAB necesita un esquema para crear un punto de conexión de GraphQL estructurado.

Crear ese esquema manualmente puede ser complejo. Con esta versión, la CLI de DAB incluye una característica de generación de esquemas. Al muestrear los datos en función de las entidades que defina, genera un esquema de trabajo, lo que requiere solo una revisión mínima y actualizaciones para empezar.

dab init 
  --database-type cosmosdb_nosql 
  --connection-string @env('cosmos-connection-string') 
  --cosmosdb_nosql-database MyDatabase
  --cosmosdb_nosql-container MyContainer

dab add MyEntity
  --source "MyDatabase.MyEntity"
  --permissions "anonymous:*"
  --graphQL "MyEntity:MyEntities"

dab export
  --graphql
  --generate
  -o ./schemas

dab start

Línea de comandos para todo

A medida que evoluciona Data API Builder, el archivo de configuración crece más largo y sofisticado. Este formato es JSON (fácil de leer y editar) también es fácil de interrumpir con una coma o corchetes mal colocados. Esta opción es la razón por la que la CLI de DAB ayuda a los desarrolladores a modificar la configuración de forma segura sin editar JSON directamente.

En la versión 1.3, el nuevo dab configure subcomando actualiza casi todas las opciones de las runtime secciones y data-source . Esta actualización acerca a DAB a la cobertura completa de la CLI y cada versión continúa expandiendo esa cobertura.

Ejemplo: Actualización data-source

Opción 1: Un comando completo

dab configure 
  --data-source.database-type cosmosdb_nosql
  --data-source.options.database testdbname 
  --data-source.options.schema testschema.gql

Opción 2: Varios comandos más pequeños

dab configure --data-source.database-type cosmosdb_nosql
dab configure --data-source.options.database testdbname
dab configure --data-source.options.schema testschema.gql

Una nota sobre database-type

Algunas opciones son específicas del tipo de base de datos. Si la configuración usa mssql actualmente y aplica opciones de Cosmos DB sin cambiar primero a cosmosdb_nosql, se produce un error en el comando.

Más ejemplos

dab configure --runtime.graphql.enabled true
dab configure --runtime.graphql.path /updatedPath
dab configure --runtime.graphql.allow-introspection true 
dab configure --runtime.graphql.multiple-mutations.create.enabled true

DAB sigue avanzando hacia una cobertura de línea de comandos completa, incluso para propiedades de configuración profundamente anidadas.