Importación de metadatos de OData de SAP como API

SE APLICA A: Todos los niveles de API Management

En este artículo se describe cómo importar un servicio OData (Open Data Protocol) en Azure API Management mediante metadatos de OData. En el ejemplo siguiente se usa SAP Gateway Foundation.

En este artículo aprenderá a:

• Recuperación de metadatos de OData del servicio SAP
• Importar metadatos de OData a Azure API Management, ya sea directamente o después de convertirlos en una especificación de OpenAPI
• Completar la configuración de la API
• Prueba de la API en el portal de Azure

Requisitos previos

• Cree una instancia de API Management.

• Un sistema SAP y un servicio que se exponen como OData v2 o v4.

• Si el back-end de SAP usa un certificado autofirmado (para pruebas), es posible que deba deshabilitar la comprobación de la cadena de confianza para SSL. Para ello, configure un back-end en la instancia de API Management:

  1. En Azure Portal, en API, seleccione Back-end>+ Crear nuevo back-end.
  2. Agregue una dirección URL personalizada que apunte al servicio back-end de SAP.
  3. Expanda la sección Avanzadas y desactive las casillas Validar cadena de certificados y Validar nombre de certificado .

  Nota

  En escenarios de producción, use certificados adecuados para la comprobación SSL de un extremo a otro.

  Sugerencia

  Para obtener el ámbito de características completo de API Management, convierta la API de OData de SAP en la especificación de OpenAPI antes de registrarse.

Recuperación de metadatos de OData del servicio SAP

Recupere el XML de metadatos del servicio SAP mediante uno de los métodos siguientes. Si tiene previsto convertir el XML de metadatos en una especificación de OpenAPI, guarde el archivo localmente.

• Use el cliente de puerta de enlace de SAP (transacción /IWFND/GW_CLIENT).
• Realice una llamada HTTP directa para recuperar el XML: http://<OData server URL>:<port>/<path>/$metadata.
• Use el centro de aceleradores de negocios de SAP si procede.

Vaya a la instancia de API Management.

1. En Azure Portal, busque y seleccione Servicios de API Management:

   

2. En la página Servicios de API Management , seleccione la instancia de API Management:

   

Importación de una API a API Management

Elija uno de los métodos siguientes para importar la API a API Management:

• Convierta el XML de metadatos en una especificación de OpenAPI (recomendado).
• Importe el XML de metadatos como una API de OData directamente.

Especificación de OpenAPI (recomendado)

Conversión de metadatos de OData en JSON de OpenAPI

1. Use el convertidor Microsoft basado en la herramienta de código abierto OASIS.

   En el ejemplo siguiente se convierte OData v2 XML para el servicio epm_ref_apps_prod_man_srvde prueba :

   oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json
   

   Nota

   Para realizar pruebas con un único archivo XML, puede usar la experiencia basada en web.

2. Guarde el archivo openapi-spec.json localmente para importarlo a API Management.

Importación de la especificación de OpenAPI

1. En el menú de la barra lateral, en la sección API , seleccione API.

2. En Crear a partir de la definición, seleccione el icono de OpenAPI :

   

3. Elija Seleccionar un archivo y, a continuación, seleccione el archivo openapi-spec.json que guardó localmente en un paso anterior.

4. Introduzca la configuración de la API. Puede establecer estos valores al importar la API o configurarlos más adelante; para ello, vaya a la pestaña Configuración .

   • En Sufijo de dirección URL de la API, se recomienda usar la misma ruta de acceso URL que en el servicio SAP original.

   • Para obtener más información sobre la configuración de API, vea el tutorial Importación y publicación de la primera API.

5. Selecciona Crear.

También debe configurar la autenticación en el back-end mediante un método adecuado para su entorno. Para obtener ejemplos, consulte Autenticación y autorización.

Nota

Para obtener información sobre las limitaciones de importación de API, consulte Restricciones de importación de API y problemas conocidos.

Prueba de la API

1. Dirígete a tu instancia de Administración de API.

2. En el menú de la barra lateral, seleccione APIs>APIs.

3. En Todas las API, seleccione la API importada.

4. Seleccione la pestaña Prueba para acceder a la consola de prueba.

5. Seleccione una operación, escriba los valores necesarios y, a continuación, seleccione Enviar.

   Por ejemplo, pruebe la llamada GET /$metadata para verificar la conectividad con el backend de SAP.

6. Visualice la respuesta. Para solucionar problemas, haga un seguimiento de la llamada.

7. Cuando haya terminado las pruebas, salga de la consola de prueba.

Metadatos de OData

Importación de metadatos de OData

1. En el menú de la barra lateral, seleccione API API> y, a continuación, seleccione + Agregar API.

2. En Crear a partir de la definición, seleccione el icono de OData :

   

3. Introduzca la configuración de la API. Para actualizar la configuración más adelante, vaya a la pestaña Configuración de la API.

   1. En especificación de OData, escriba una dirección URL para un punto de conexión de metadatos de OData. Este valor suele ser la dirección URL de la raíz del servicio, anexada a /$metadata. Como alternativa, seleccione un archivo XML de OData local para importar.

   2. Escriba opciones adicionales para configurar la API. Estos valores de configuración se explican en el tutorial Importación y publicación de la primera API.

4. Selecciona Crear.

   La API se agrega a la lista de API. Los conjuntos de entidades y las funciones que se exponen en la descripción de metadatos de OData aparecen en la pestaña Conjuntos de entidades y funciones de la API.

   

Actualización del esquema de OData

Puede acceder a un editor en el portal para ver el esquema de OData de la API. Si la API cambiase, también podrá actualizar el esquema en API Management desde un archivo o un punto de conexión de servicio de OData.

1. En el menú de la barra lateral, API>API y, a continuación, seleccione la API de OData.

2. En la pestaña Conjuntos de entidades y funciones , seleccione los puntos suspensivos (...) situados junto a un conjunto de entidades o una función y, a continuación, seleccione Editar.

   

3. Revisar el esquema. Si quiere actualizarlo, seleccione Actualizar desde archivo o Actualizar esquema desde el punto de conexión.

   

Prueba de la API de OData

1. En el menú de la barra lateral, API>API y, a continuación, seleccione la API de OData.

2. En la pestaña Conjuntos de entidades y funciones , seleccione los puntos suspensivos (...) situados junto a un conjunto de entidades o una función y, a continuación, seleccione Probar.

   

3. En la consola de prueba, escriba parámetros de plantilla, parámetros de consulta y encabezados para la prueba y, a continuación, seleccione Probar. Para obtener más información sobre las API de prueba en el portal, consulte Probar la nueva API en el portal.

Protección de la API de OData

Proteja la API de OData aplicando directivas de autenticación y autorización existentes y una directiva de validación de OData para protegerse frente a ataques a través de solicitudes de API de OData.

Sugerencia

En el portal, configure directivas para la API de OData en la pestaña Directivas de API.

Consideraciones de producción

• Utiliza Defender para APIs para una cobertura completa en protección de ciclo de vida, detección y respuesta para APIs.
• Consulte un escenario de ejemplo de extremo a extremo para integrar API Management con un SAP Gateway.
• Controlar el acceso a un back-end de SAP mediante directivas de API Management. Por ejemplo, si la API se importa como una API de OData, use la directiva validar solicitud de OData. También hay fragmentos de directivas para la propagación principal de SAP para SAP ECC o S/4HANA o SAP SuccessFactors y obtener un token X-CSRF.
• Para obtener instrucciones sobre la implementación, administración y migración de API a escala, consulte:
  • Implementaciones automatizadas de API con APIOps
  • Uso de DevOps y CI/CD para publicar API

Contenido relacionado

• Limitaciones de importación de API
• Importación de una especificación de OpenAPI
• Importación de una API de SOAP
• Importar una API de SOAP y convertir en REST
• Importar una API de servicio de aplicaciones
• Importación de una API de aplicación de contenedor
• Importación de WebSocket API
• Importación de GraphQL API
• Importación de un esquema GraphQL y configuración de solucionadores de campos
• Importación de una API de aplicación de funciones
• Importación de una API de aplicación lógica
• Importación de un servicio Service Fabric
• Importación de una API de Microsoft Foundry
• Importar una API de OpenAI Azure
• Importación de una API de LLM
• Importación de una API de OData
• Exportación de una API REST como servidor MCP
• Exposición de un servidor MCP existente
• Importación de una API de agente de A2A
• Importación de metadatos de SAP OData
• Importación de una API de gRPC
• Edición de una API