Migración del portal de API con el plan Enterprise de Azure Spring Apps a Azure API Management

Nota:

Los planes de Básico, Estándar y Enterprise quedarán en desuso a partir de mediados de marzo de 2025, con un período de retiro de 3 años. Se recomienda realizar la transición a Azure Container Apps. Para más información, consulte el anuncio de retirada de Azure Spring Apps.

El plan de consumo estándar y dedicado quedará obsoleto a partir del 30 de septiembre de 2024, con un cierre completo al cabo de seis meses. Se recomienda realizar la transición a Azure Container Apps. Para obtener más información, consulte Migrar el plan de consumo y dedicado Azure Spring Apps Standard a Azure Container Apps.

Este artículo se aplica a: ❎ Básico/Estándar ✅ Enterprise

En este artículo se describe cómo migrar el portal de API a Azure API Management.

Azure API Management proporciona una interfaz centralizada para ver definiciones de API y probar rutas de API específicas directamente desde el explorador. También admite el inicio de sesión único (SSO) para mejorar la seguridad y el acceso. La migración del portal de API con Azure Spring Apps a Azure API Management mejora la escalabilidad, la seguridad y la integración con otros servicios de Azure.

Requisitos previos

• Una instancia del plan Enterprise de Azure Spring Apps existente con el portal de API habilitado.
• Una aplicación contenedora de Azure existente. Para obtener más información, consulte Inicio rápido: implementación de la primera aplicación contenedora mediante Azure Portal.

Creación de una instancia de API Management

Siga estos pasos para crear una instancia de API Management:

1. En Azure Portal, busque API Management en la barra de búsqueda.

2. Seleccione Servicios de API Management en los resultados y, a continuación, seleccione Crear.

3. Proporcione la siguiente información obligatoria:

   • Suscripción: seleccione la suscripción de Azure para el servicio.
   • Grupo de recursos: seleccione uno existente o seleccione Crear nuevo para crear uno nuevo.
   • Región: elija la ubicación o región de la instancia de API Management.
   • Nombre del recurso: proporcione un nombre único global para la instancia de API Management.
   • Nombre de la organización: especifique el nombre de la organización.
   • Correo electrónico de administrador: proporcione una dirección de correo electrónico para las notificaciones relacionadas con la instancia de API Management.

4. Elija el plan de tarifa en función del caso de uso. Siempre puede actualizar o cambiar el plan de tarifa más adelante.

5. Configure opciones opcionales, como la supervisión y la configuración de la red virtual.

6. Seleccione Revisar y crear para revisar la configuración y validarla.

7. Una vez completada la validación, seleccione Crear. La implementación puede tardar entre 30 y 40 minutos.

8. Una vez completada la implementación, vaya a la página Servicio de API Management para ver el servicio recién creado.

Importación de las API expuestas en API Management

Hay dos opciones para importar las API en API Management: agregarlas manualmente o importar un archivo de especificación de API.

Adición manual de API

Siga estos pasos para agregar manualmente las API:

1. Vaya a la instancia de API Management en Azure Portal. En la sección API, seleccione Agregar API.

2. En el panel Definir una nueva API, seleccione la opción HTTP para definir manualmente una API HTTP.

3. Proporcione los siguientes valores para Conceptos básicos de API y, a continuación, seleccione Crear para guardar:

   • Nombre para mostrar: proporcione cualquier nombre para la API.
   • Nombre: escriba un identificador único para la API.
   • Dirección URL del servicio web: especifique la dirección URL base de la API de back-end de su instancia de Container Apps.
   • Sufijo de dirección URL de API: defina el sufijo para esta API; por ejemplo, /api/customers-service.

4. Para crear nuevos puntos de conexión de API, seleccione Agregar operación y siga estos pasos:

   1. Proporcione la información general. Introduzca los valores para Nombre para mostrar y Nombre.
   2. Proporcione los detalles de la operación, como el verbo HTTP - GETPOST, etc., la dirección URL, los parámetros de consulta, la solicitud y la respuesta.
   3. Después de agregar todas las operaciones, guarde la API.

5. Seleccione los nombres de las API agregadas. Puede ver todas las operaciones agregadas en la pestaña Diseño.

Importación de un archivo de especificación de API

Si tiene una especificación de OpenAPI (una definición de Swagger) de las API, puede importarla directamente a API Management mediante los pasos siguientes:

1. Vaya a la instancia de API Management en Azure Portal.

2. Abra la sección API en API.

3. Seleccione Agregar API.

4. En Crear desde la definición, elija la opción OpenAPI. Esta opción crea una interfaz estándar independiente del lenguaje para las API de REST.

5. Siga estos pasos para crear una API a partir de una especificación de OpenAPI:

   1. Si tiene un archivo local de especificación de API, seleccione Seleccionar un archivo para cargarlo. Como alternativa, proporcione una dirección URL de acceso público a la especificación de OpenAPI.
   2. Puede refinar aún más la configuración de la API proporcionando valores para Nombre para mostrar, Nombre y Sufijo de dirección URL de API para las API.
   3. Para guardar las configuraciones, seleccione Crear.

6. Seleccione el nombre de las API agregadas. Puede ver todas las operaciones agregadas en la pestaña Diseño.

Prueba de las API en API Management

Azure API Management proporciona una consola de pruebas integrada en Azure Portal, lo que facilita la interacción con las API sin necesidad de herramientas externas. Siga estos pasos para probar las API:

1. Vaya a la instancia de API Management en Azure Portal.

2. En la sección API, seleccione la API que desea probar de la lista.

3. Elija un operador. Dentro de la página de información general de la API, puede ver una lista de operaciones disponibles (puntos de conexión). Seleccione la operación que desea probar.

4. Seleccione la pestaña Prueba para abrirla en Azure Portal.

5. Configure los parámetros de solicitud. Escriba los parámetros necesarios para la solicitud, como Parámetros de ruta de acceso, Parámetros de consulta, Encabezados o Cuerpo, según el método de API. Si una API requiere un elemento Authorization Token, asegúrese de incluirlo en el encabezado.

6. Envíe la solicitud. Después de proporcionar los detalles de la solicitud, seleccione Enviar. La respuesta de la API se muestra directamente en Azure Portal, incluido el código de respuesta, el cuerpo de la respuesta y los encabezados.

7. Inspeccione la respuesta. Revise los datos de respuesta, los códigos de estado y los mensajes de error que puedan indicar problemas con la API o la solicitud.

Migración del inicio de sesión único a API Management

Si habilita el inicio de sesión único (SSO) en el portal de API y quiere autenticar también las solicitudes en API Management, siga estos pasos para configurar la identidad en API Management:

1. En Azure Portal, vaya a la instancia de API Management.

2. Vaya al Portal para desarrolladores>identidades.

3. Seleccione Agregar y, a continuación, seleccione Azure Active Directory.

4. Rellene todos los campos obligatorios:

   • Id. de cliente: la aplicación o el identificador de cliente de la aplicación de Microsoft Entra ID registrada.
   • Secreto de cliente: el secreto de la aplicación de Microsoft Entra ID.
   • Inquilino de inicio de sesión: el nombre de dominio del inquilino de Microsoft Entra ID, como yourcompany.onmicrosoft.com.
   • URL de redireccionamiento: normalmente https://{your-apim-instance}.developer.azure-api.net/signin.

5. Seleccione Agregar para guardar el proveedor de identidades.

Debe agregar la URL de redireccionamiento a la lista de direcciones URL de redireccionamiento permitidas de la aplicación cliente de Microsoft Entra ID antes de guardar el nuevo proveedor de identidades agregado.

Para información sobre más configuraciones de API Management, consulte la documentación de API Management.