Generador de API de datos de host en Azure Static Web Apps (versión preliminar)

Diagrama de la secuencia de la guía de implementación, incluidas estas ubicaciones, en orden: Información general, Plan, Preparación, Publicación, Monitor y Optimización. La ubicación "Publicar" está resaltada ahora.

Construir rápidamente una API de datos de host en Azure Static Web Apps usando solo un archivo de configuración. En esta guía se incluyen los pasos para integrar Data API Builder con una aplicación web estática.

En esta guía, siga los pasos para crear un archivo de configuración DAB, hospedar el archivo como parte de la aplicación y, a continuación, usar una conexión de base de datos en Azure Static Web Apps.

Prerrequisitos

Importante

La compatibilidad con data API Builder (DAB) en Azure Static Web Apps mediante conexiones de base de datos está en versión preliminar. Azure Static Web Apps usa una versión fija del motor DAB que puede variar de la versión estable más reciente de DAB. Para acceder a las características más recientes de DAB, considere un host alternativo para DAB mediante la versión más reciente del motor desde GitHub, Microsoft Container Registry (Docker Hub) o NuGet.

• Una cuenta de Azure con una suscripción activa. Cree una cuenta gratuita.
• CLI de Azure Static Web Apps. Instale la CLI de Static Web Apps (SWA).
• CLI para el generador de APIs de datos. Instale la CLI de Data API Builder (DAB).
• Base de datos compatible existente accesible por Azure.
• Aplicación web existente en un repositorio de GitHub que se puede implementar en Azure Static Web Apps.
  • Si no tiene una aplicación web, genere un repositorio con una aplicación web básica.

Creación de una aplicación web estática

Para empezar, use Azure Portal para crear una nueva aplicación web estática de Azure mediante la aplicación web en GitHub.

1. Inicie sesión en Azure Portal (https://portal.azure.com).

2. Cree un nuevo grupo de recursos. Usará este grupo de recursos para gestionar todos los recursos nuevos de esta guía.

   

   Sugerencia

   Se recomienda asignar un nombre al grupo de recursos msdocs-dab-swa. Todas las capturas de pantalla de esta guía usan este nombre.

3. Cree una aplicación web estática de Azure. Use estas opciones para configurar la aplicación web estática.

   Configuración	Valor
   Grupo de recursos	Seleccione el grupo de recursos que creó anteriormente.
   Nombre	Escriba un nombre único global.
   Tipo de plan	Seleccione la mejor opción para la carga de trabajo.
   Fuente	Seleccione GitHub.
   Cuenta de GitHub	Configuración de una cuenta de GitHub que tiene acceso al repositorio de aplicaciones web
   Organización	Seleccione la organización principal o el usuario para el repositorio.
   Repositorio	Seleccione el nombre del repositorio.
   Rama	Selección de la rama principal

   

4. Espere a que se complete la implementación de la aplicación web estática. Un flujo de trabajo de GitHub Actions se agrega automáticamente a tu repositorio que implementará la aplicación en Azure Static Web Apps cada vez que hagas push a la rama principal.

   Nota:

   Esta implementación inicial puede tardar unos minutos. Siempre puede comprobar el estado de la implementación en Azure Portal o en la pestaña Acciones de GitHub del repositorio.

5. Vaya a la nueva aplicación web estática en Azure Portal.

6. En la sección Essentials , use el hipervínculo url para ir a la aplicación web en ejecución. Compruebe que la aplicación se está ejecutando según lo previsto.

Adición del archivo de configuración DAB

Ahora, use las interfaces de línea de comandos DAB y SWA para crear un nuevo archivo de configuración DAB y agregarlo al repositorio de aplicaciones web.

1. Abra el repositorio de GitHub para la aplicación web en el entorno integrado para desarrolladores (IDE) que prefiera.

   Sugerencia

   Puede usar cualquier IDE que quiera. Si desea trabajar en la aplicación localmente, puede clonar el repositorio en el equipo local. Si prefiere trabajar en el explorador, puede usar GitHub Codespaces. Asegúrese de que las CLIs SWA y DAB estén instaladas en el entorno de desarrollo.

2. Abra un terminal en la raíz del repositorio.

3. Use el swa db comando de la CLI de SWA para inicializar un nuevo archivo de configuración DAB mediante el tipo de base de datos especificado. El comando creará un nuevo archivo denominado staticwebapp.database.config.json en la carpeta swa-db-connections .

   swa db init --database-type "<database-type>"
   

   Importante

   Algunos tipos de base de datos requerirán opciones de configuración adicionales en la inicialización.

4. Use el dab add comando para agregar al menos una entidad de base de datos a la configuración. Configure cada entidad para permitir todos los permisos para los usuarios anónimos. Repita dab add tantas veces como quiera para tus entidades.

   dab add "<entity-name>" --source "<schema>.<table>" --permissions "anonymous:*" --config "swa-db-connections/staticwebapp.database.config.json"
   

5. Abra y revise el contenido del archivo swa-db-connections/staticwebapp.database.config.json.

6. Confirme los cambios en el repositorio e insértelos en la rama principal. Esto desencadenará automáticamente una nueva implementación de la aplicación web. Espere a que finalice esta implementación más reciente antes de continuar con esta guía.

Configuración de la conexión de base de datos

A continuación, configure la conexión de base de datos en Azure Portal para permitir que la aplicación web estática acceda a la base de datos.

1. Vuelva a ir a la aplicación web estática en Azure Portal.

2. Seleccione la opción Conexión de base de datos en la sección Configuración del menú de recursos. A continuación, seleccione Vincular base de datos existente para el entorno de producción .

   

3. En el cuadro de diálogo Vincular base de datos , use estas opciones para configurar la conexión de base de datos.

   Configuración	Valor
   Tipo de base de datos	Seleccione el mismo tipo de base de datos que usó al crear el archivo de configuración de DAB.
   Grupo de recursos	Seleccione el grupo de recursos que creó anteriormente en esta guía.
   Nombre del recurso	Seleccione el recurso de base de datos que desea vincular a la aplicación web estática.
   Nombre de la base de datos	Escriba el nombre de la base de datos.
   Tipo de autenticación	Seleccione el tipo de autenticación que quiere usar.

   

   Sugerencia

   Se recomienda usar una cadena de conexión que no incluya claves de autorización. En su lugar, use identidades administradas y control de acceso basado en roles para administrar el acceso entre la base de datos y el host. Para más información, consulte Servicios de Azure que usan identidades administradas.

Prueba del punto de conexión de la API de datos

Por último, compruebe que el punto de conexión de la API de datos está disponible en la aplicación web estática.

1. Vuelva a ir a la aplicación web estática en Azure Portal.

2. Use el campo URL de la sección Essentials para volver a ir al sitio web de la aplicación web estática.

3. Vaya a la /data-api ruta de acceso de la aplicación que se está ejecutando actualmente. Observe que la respuesta sigue indicando que el contenedor DAB está en buen estado.

   { Healthy }
   

   Nota:

   Static Web Apps establece automáticamente el modo Productionde host en tiempo de ejecución en , sobrescribiendo cualquier valor en el archivo de configuración. Como resultado, las características de desarrollador como Swagger y Banana Cake Pop no están disponibles en Static Web Apps.

4. Vaya a la https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name> ruta de acceso de la aplicación que se está ejecutando actualmente. Esto emite una solicitud HTTP GET para ese conjunto de entidades. Observe la respuesta JSON.

Limpieza de recursos

Cuando ya no necesite la aplicación o los recursos de ejemplo, quite la implementación correspondiente y todos los recursos.

1. Vaya al grupo de recursos mediante Azure Portal.

2. En la barra de comandos, seleccione Eliminar.