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

  • 7 minutos

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, incluidas, entre otras, Azure SQL, SQL Server, PostgreSQL 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 métodos de autenticación, como OAuth2, EasyAuth y Microsoft Entra ID. 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 las más recientes de .NET 8 y la CLI para desarrolladores de Azure.

  1. Cree un nuevo proyecto: Use la CLI para desarrolladores de Azure para crear e implementar los servicios necesarios. Por ejemplo, use Azure Developer CLI para implementar una aplicación web estática de Azure que hospede el generador de API de datos. Vaya al directorio donde desea crear el proyecto y ejecute el siguiente comando para crear un proyecto de la aplicación web estática de Azure.

    azd init --template staticwebapp
azd up

  2. Configure la conexión de base de datos: Vincule azure SQL Database a la aplicación web estática implementada mediante la característica conexiones de base de datos. Vaya a la aplicación web estática de Azure que creó y, en Configuración, vincule una base de datos existente en la página Conexión de base de datos .

  3. Definir puntos de conexión de API: cree un archivo de configuración para definir los puntos de conexión REST o GraphQL. Este archivo especifica los objetos de base de datos que se van a exponer y las operaciones permitidas. Por ejemplo, puede ejecutar el siguiente comando para agregar las entidades de base de datos al archivo de configuración.

    dab add "Address" --source "dbo.Address" --permissions "anonymous:*" --config "swa-db-connections/staticwebapp.database.config.json"

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.

{
  "data-source": {
    "database-type": "mssql",
    "connection-string": "Server=tcp:your_server.database.windows.net,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;"
  },
  "entities": {
    "products": {
      "source": "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.