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 mediante su descripción de metadatos. SAP Gateway Foundation se usa como ejemplo.

En este artículo, usted:

• Recuperación de metadatos de OData del servicio SAP
• Importación de metadatos de OData en 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 Azure Portal

Requisitos previos

• Una instancia de API Management. Si no tiene una, complete los pasos descritos en Creación de una instancia de API Management mediante Azure Portal.

• 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-ends>+ Agregar.
  2. Agregue una dirección URL personalizada que apunte al servicio back-end de SAP.
  3. 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.

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).
  o
• Realice una llamada HTTP directa para recuperar el XML: http://<OData server URL>:<port>/<path>/$metadata.

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:

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

Metadatos de OData

Importación de metadatos de OData

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

2. En Crear a partir de la definición, seleccione 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. Seleccione 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 portal, vaya a la instancia de Administración de API.

2. En el menú de la izquierda, seleccione API y, a continuación, seleccione la API de OData.

3. 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.

   

4. 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 izquierda, seleccione 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.

Especificación OpenAPI

Conversión de metadatos de OData en JSON de OpenAPI

1. Convierta el XML de OData al formato JSON de OpenAPI. Use una herramienta de código abierto OASIS para OData v2 u OData v4, en función del XML de metadatos.

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

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   Nota

   • Para realizar pruebas con un único archivo XML, puede usar un convertidor basado en web basado en una herramienta de código abierto.
   • Con la herramienta o el convertidor basado en web es opcional especificar la <dirección IP>:<puerto> del servidor de OData de SAP. Como alternativa, agregue esta información más adelante en la especificación de OpenAPI generada o después de importar el archivo a API Management.

2. Guarde el archivo openapi-spec.json localmente para importar en API Management.

Importación de la especificación de OpenAPI

1. En el panel de navegación izquierdo, en la sección API , seleccione API.

2. En Crear una nueva definición, seleccione OpenAPI:

   

3. Haga clic en Seleccionar un archivo y, a continuación, seleccione el openapi-spec.json archivo 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. Seleccione Crear.

Nota

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

Completar la configuración de la API

Agregue las tres operaciones siguientes a la API que importó:

• GET /$metadata

  Operación	Descripción	Configuración adicional para la operación
  GET /$metadata	Permite a API Management alcanzar el punto de conexión $metadata, que es necesario para la integración del cliente con el servidor de OData. Esta operación necesaria no se incluye en la especificación de OpenAPI generada e importada.	Agregue una respuesta 200 OK.

  

• HEAD /

  Operación	Descripción
  HEAD /	Permite al cliente intercambiar tokens de falsificación de solicitud entre sitios (CSRF) con el servidor SAP si es necesario. SAP también permite el intercambio de tokens CSRF a través del verbo GET. El intercambio de tokens CSRF no se trata en este artículo. Consulte un fragmento de código de una directiva de API Management de ejemplo para mediar el intercambio de tokens.

  

• GET /

  Operación	Descripción	Configuración adicional para la operación
  GET /	Habilita la configuración de directiva en la raíz del servicio.	Configure la siguiente política de reescritura de URI de entrada para anexar una barra diagonal final a las solicitudes que se reenvían a la raíz del servicio. <rewrite-uri template="/" copy-unmatched-params="true" /> Esta directiva elimina la posible ambigüedad entre las solicitudes con y sin barras diagonales finales. Algunos back-end tratan de forma diferente estos dos tipos de solicitudes.

  

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

Prueba de la API

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

2. En el panel de navegación izquierdo, en la sección API , seleccione API.

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.

Consideraciones de producción

• 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 directiva para la propagación de entidades de seguridad de SAP para SAP ECC o S/4HANA o SAP SuccessFactors y capturar 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.
  • CI/CD para la administración de API mediante plantillas de Azure Resource Manager.

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 un API de App Service
• 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 Azure AI Foundry
• Importación de una API de Azure OpenAI
• Importación de una API de LLM
• Importación de una API de OData
• Importación de metadatos de SAP OData
• Importación de una API de gRPC
• Edición de una API