Skip to content

Inicio rápido: Use App Builder con Data API Builder de Microsoft para Cualquier Base de Datos

Esta guía proporciona un proceso paso a paso para configurar y usar Data API Builder con cualquier base de datos, lista completa de las bases de datos admitidas - SQL Server, MySQL y PostgreSQL, por nombrar algunas. Siga estas instrucciones para crear puntos finales REST con OpenAPI nativo, Swagger y administrar su base de datos de manera eficiente.

Características principales

  • Soporte para tablas relacionales, vistas y procedimientos almacenados
  • Soporte para múltiples fuentes de datos simultáneas
  • Puntos finales REST
    • POST, GET, PUT, PATCH, DELETE
    • Filtrado, ordenamiento y paginación
    • Caché en memoria
    • Soporte para OpenAPI
  • Desarrollo fácil mediante CLI dedicado
  • Código abierto y gratuito

Este diagrama detalla la relación entre todos los componentes de la Arquitectura de Data API Builder.

Arquitectura de DAB


1. Instale el paquete Microsoft.DataApiBuilder desde NuGet como una herramienta .NET

Para comenzar, use dotnet tool install para instalar la última versión de Microsoft.DataApiBuilder con el argumento —global:

dotnet tool install -g Microsoft.DataApiBuilder
Note

Si el paquete ya está instalado, actualizará el paquete en su lugar utilizando dotnet tool update

dotnet tool update --global Microsoft.DataApiBuilder

Para obtener más detalles, consulte la documentación oficial: .

2. Configuración de la Base de Datos

Asegúrese de tener una base de datos configurada. Puede usar herramientas como SQL Server Management Studio, MySQL Workbench o cualquier otra herramienta de administración de bases de datos para crear y configurar su base de datos. Para esta guía, proporcionaremos ejemplos para la base de datos MSSQL.

3. Puntos Finales REST en Data API Builder creados a través de un Archivo de Configuración

Data API Builder proporciona una API web RESTful que le permite acceder a tablas, vistas y procedimientos almacenados desde una base de datos conectada. Las entidades representan un objeto de base de datos en la configuración en tiempo de ejecución de Data API Builder. Una entidad debe establecerse en la configuración en tiempo de ejecución para que esté disponible en el punto final de la API REST.

Ahora vamos a crear un archivo de configuración base usando la CLI de DAB. Documentos oficiales. Este archivo de configuración es necesario para definir cómo Data API Builder interactúa con su base de datos.

Ejecute el siguiente comando para inicializar un archivo de configuración basado en la cadena de conexión MSSQL.

dab init --database-type "mssql" --host-mode "Development" --connection-string "Server=DEV-ZKOLEV4\SQLEXPRESS;User Id=INFRAGISTICS/ZKolev;Database=NorthwindCRUD;Integrated Security=True;TrustServerCertificate=True;Encrypt=False;"

Agregue las entidades con las que trabajará su API REST

Agregue una entidad (por ejemplo, Products) al archivo de configuración:

dab add Products --source "Products" --permissions "anonymous:*"

Observe su archivo de configuración dab-config.json actual

El archivo debe incluir una implementación base de su API con una única entidad, un punto final de API REST:

Note

Habilite CORS si es necesario (Opcional). Para permitir solicitudes entre orígenes, habilite CORS en su configuración agregando lo siguiente a su custom-config.json:

"origins": ["*"]
{
  "$schema": "https://github.com/Azure/data-api-builder/releases/download/v1.4.26/dab.draft.schema.json",
  "data-source": {
    "database-type": "mssql",
    "connection-string": "Server=DEV-ZKOLEV4\\SQLEXPRESS;User Id=INFRAGISTICS/ZKolev;Database=NorthwindCRUD;Integrated Security=True;TrustServerCertificate=True;Encrypt=False;",
    "options": {
      "set-session-context": false
    }
  },
  "runtime": {
    "rest": {
      "enabled": true,
      "path": "/api",
      "request-body-strict": true
    },
    "graphql": { ... },
    "host": {
      "cors": {
        "origins": [
          "*"
        ],
        "allow-credentials": false
      },
      "authentication": {
        "provider": "StaticWebApps"
      },
      "mode": "development"
    }
  },
  "entities": {
    ...
    "Products": {
      "source": {
        "object": "Products",
        "type": "table"
      },
      "graphql": {
        "enabled": true,
        "type": {
          "singular": "Products",
          "plural": "Products"
        }
      },
      "rest": {
        "enabled": true
      },
      "permissions": [
        {
          "role": "anonymous",
          "actions": [
            {
              "action": "*"
            }
          ]
        }
      ]
    }
  }
}

4. Pruebe la API REST

Ahora, inicie la herramienta Data API Builder para validar que todo esté configurado correctamente.

dab start

Salida. Una vez que la API esté en ejecución, puede acceder a ella en http://localhost:5000/swagger/index.html

Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]

Esta URL abrirá la interfaz de usuario de Swagger, donde puede probar sus puntos finales de API.

Ejemplo de Swagger DAB

6. Comience a usar App Builder con la API REST recién creada

Para un tutorial paso a paso siga este tema.

DAB en AB

6. Solución de Problemas Comunes

Aquí hay algunos problemas comunes y sus soluciones:

  • En App Builder el CRUD funciona solo para Grid, para el componente Form hay algunas piezas faltantes de la especificación de OpenAPI que actualmente están en progreso.

  • Problemas de CORS. Cómo habilitar CORS si es necesario:

"host": {
    "cors": {
    "origins": [
        "*"
    ],
    "allow-credentials": false
    },
    "authentication": {
    "provider": "StaticWebApps"
    },
    "mode": "development"
}
  • Propuesta de soporte de OpenID Connect - Problema en GitHub de data-api-builder.

  • ¿El punto final DELETE no funciona? Asegúrese de que la operación DELETE esté habilitada en los permisos de la entidad (por ejemplo, “anonymous:*” incluye DELETE).

  • ¿Problemas con la cadena de conexión? Verifique el nombre de usuario, contraseña y método de autenticación (por ejemplo, Autenticación de Windows o Autenticación SQL) en su cadena de conexión.

Recursos Adicionales