Exploración del generador de API de datos para Azure SQL Database

Completados

En el mundo actual controlado por datos, la capacidad de acceder y manipular datos de forma eficaz es fundamental para empresas y desarrolladores por igual. Data API Builder (DAB) ofrece una solución eficaz para crear puntos de conexión REST y GraphQL modernos para azure SQL Database, reemplazando las API personalizadas que realizan operaciones CRUD (Crear, Leer, Actualizar, Eliminar) en una base de datos.

El generador de API de datos de Azure es una herramienta de código abierto diseñada para desarrolladores para simplificar el proceso de exponer los objetos de base de datos como puntos de conexión. Admite muchas bases de datos, entre las que se incluyen Azure SQL, SQL Server, PostgreSQL, MySQL y Azure Cosmos DB. Con DAB, puede crear API seguras, escalables y de alto rendimiento sin costo adicional, sin necesidad de escribir ningún código.

Diagrama que muestra la relación entre todos los componentes del generador de Data API.

Detección de características clave

El uso de DAB en el proceso de desarrollo ofrece muchas ventajas. Estas son algunas ventajas clave que pueden ayudarle a determinar la alineación con los requisitos del proyecto.

  • Compatibilidad multiplataforma: DAB es multiplataforma y se puede ejecutar en cualquier entorno local o en la nube. Admite varios orígenes de datos backend, incluidas las bases de datos relacionales y NoSQL.
  • Seguridad y autenticación: DAB se integra con varios proveedores de autenticación, como Microsoft Entra ID (EntraID), App Service EasyAuth (AppService), Static Web Apps autenticación (StaticWebApps), proveedores de JWT personalizados (Custom) y un Simulator modo para el desarrollo local. También admite autorizaciones basadas en funciones y controles de seguridad granulares. Esto significa que puede exponer los datos al tiempo que mantiene el control sobre quién puede acceder a ellos y lo que pueden hacer con ellos.
  • Facilidad de uso: con un único archivo de configuración, puede definir los puntos de conexión de API, lo que hace que el proceso de configuración sea sencillo y eficaz.
  • Integración con los servicios de Azure: DAB se integra perfectamente con Azure Static Web Apps, Azure Container Apps y otros servicios de Azure, lo que mejora su funcionalidad y escalabilidad.

Para ver una lista de características disponibles para Data API Builder, consulte Disponibilidad de características para Data API Builder.

Uso del generador de API de datos

Para empezar a trabajar con Azure Data API Builder, asegúrese de tener una suscripción de Azure y de las herramientas necesarias instaladas, como .NET 8 o posterior y la CLI para desarrolladores de Azure.

  1. Instale la CLI de DAB: Instale el Microsoft.DataApiBuilder paquete NuGet como una herramienta de .NET global.

    dotnet tool install --global Microsoft.DataApiBuilder
    
  2. Inicialice un archivo de configuración: Use dab init para crear el archivo basedab-config.json, haciendo referencia a la cadena de conexión a través de una variable de entorno.

    dab init --database-type "mssql" --connection-string "@env('SQL_CONNECTION_STRING')"
    
  3. Definir puntos de conexión de API: agregue las entidades de base de datos al archivo de configuración para definir los puntos de conexión rest o GraphQL. En este paso se especifican los objetos de base de datos que se van a exponer y las operaciones permitidas. Por ejemplo, puede ejecutar el siguiente comando para agregar una entidad al archivo de configuración.

    dab add "Address" --source "dbo.Address" --permissions "anonymous:*"
    

Revisión de un archivo de configuración

A continuación se muestra un ejemplo sencillo de un archivo de configuración para exponer una tabla en su Azure SQL Database.

{
  "$schema": "https://github.com/Azure/data-api-builder/releases/latest/download/dab.draft.schema.json",
  "data-source": {
    "database-type": "mssql",
    "connection-string": "@env('SQL_CONNECTION_STRING')"
  },
  "entities": {
    "Address": {
      "source": "dbo.Address",
      "rest": true,
      "graphql": true,
      "permissions": [
        {
          "role": "anonymous",
          "actions": ["read"]
        }
      ]
    }
  }
}

Esta configuración expone la tabla Address como puntos de conexión REST y GraphQL, lo que permite el acceso de lectura a usuarios anónimos. El cadena de conexión se lee de la SQL_CONNECTION_STRING variable de entorno en tiempo de ejecución en lugar de almacenarse en el archivo de configuración.