Importación de metadatos de OData de SAP como API

SE APLICA A: todos los niveles de API Management

En este artículo se muestra cómo importar un servicio OData mediante su descripción de metadatos. En este artículo, SAP Gateway Foundation sirve de ejemplo.

En este artículo, hará lo siguiente:

• Recuperación de metadatos de OData del servicio SAP
• Importación de metadatos de OData a API Management, ya sea directamente o tras su conversión a una especificación de OpenAPI
• Completar la configuración de la API
• Prueba de la API en Azure Portal

Nota

La importación de una API de OData a API Management desde su descripción de metadatos está en versión preliminar. Más información.

Requisitos previos

• Tener una instancia de API Management existente. Cree una suscripción si todavía no lo ha hecho.

• Un sistema y un servicio SAP expuestos como OData v2 o v4.

• Si el back-end de SAP usa un certificado autofirmado (con fines de prueba), es posible que deba deshabilitar la comprobación de la cadena de confianza de 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 de back-end de SAP.
  3. Desactive Validar cadena de certificados y Validar nombre del certificado.

  Nota

  En escenarios de producción, use los 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 SAP Gateway (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 de servicios API Management, seleccione la instancia de API Management.

   

Importación de la 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 o convierta el XML de metadatos en una especificación de OpenAPI.

Metadatos de OData

Importación de metadatos de OData

1. En el menú izquierdo, seleccione API>+Agregar API.

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

   

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

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

   2. Escriba los valores restantes 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 API Management.

2. En el menú izquierdo, seleccione API> API de OData.

3. En la pestaña Conjuntos de entidades y funciones, selecciona el menú contextual (...) junto a un conjunto de entidades o función, y selecciona 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ú izquierdo, seleccione API> API de OData.

2. En la pestaña Conjuntos de entidades y funciones, selecciona el menú contextual (...) junto a un conjunto de entidades o función, y selecciona Probar.

   

3. En la consola de prueba, escribe los parámetros de plantilla, parámetros de consulta y encabezados para la prueba y seleccione Probar. Obtén más información sobre cómo probar una API en el portal.

Protección de la API de OData

Asegura la API de OData mediante la aplicación de directivas de autenticación y autorización y una directiva de validación de OData existentes para protegerse frente a ataques mediante 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.

   A continuación se muestra un comando de ejemplo para convertir XML de OData v2 para el servicio de prueba epm_ref_apps_prod_man_srv:

   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 fines de prueba con un único archivo XML puede usar un convertidor basado en web basado en la 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 en API Management.

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

Importación y publicación de API de back-end

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

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

   

3. Haga clic en Seleccionar un archivo y seleccione el archivo openapi-spec.json que ha guardado localmente en un paso anterior.

4. Escriba los valores de la API. Puede establecer los valores durante la creación o luego accediendo a la pestaña Ajustes.

   • En Sufijo de dirección URL de 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

Las limitaciones de la importación de API se documentan en otro artículo.

Completar la configuración de la API

Agregue las tres operaciones siguientes a la API que ha importado.

• 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	Configuración adicional para la operación
  HEAD /	Permite al cliente intercambiar tokens de falsificación de solicitud entre sitios (CSRF) con el servidor SAP en caso necesario. SAP también permite el intercambio de tokens CSRF mediante el verbo GET. El intercambio de tokens CSRF no se trata en este artículo. Vea un ejemplo de fragmento de directiva de API Management para el intercambio de tokens de agente.	N/D

  

• GET /

  Operación	Descripción	Configuración adicional para la operación
  GET /	Habilita la configuración de directivas en la raíz del servicio.	Configure la siguiente directiva rewrite-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 quita la posible ambigüedad de las solicitudes con o sin barras diagonales finales, que algunos back-end tratan de forma diferente.

  

Además, configure la autenticación en el back-end mediante un método adecuado para el entorno. Para obtener ejemplos, consulta Directivas de autenticación y autorización de API Management.

Prueba de la API

1. Navegue hasta su instancia de API Management.

2. En el menú de navegación lateral, 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 seleccione Enviar.

   Por ejemplo, pruebe la llamada GET /$metadata para comprobar la conectividad con el back-end de SAP.

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

7. Una vez completadas las pruebas, salga de la consola de prueba.

Consideraciones de producción

• Vea un escenario de un extremo a otro de ejemplo para integrar API Management con una puerta de enlace de SAP.
• Controle 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. Consulte también los fragmentos de directivas para propagación de los tokens de entidad de seguridad y captura de un token X-CSRF.
• Para obtener instrucciones para implementar, administrar y migrar API a gran escala, vea:
  • Implementaciones automatizadas de API con APIOps
  • CI/CD para API Management mediante plantillas de Azure Resource Manager.

Temas relacionados

• Limitaciones de importación de API
• Importación de una especificación de OpenAPI
• Importación de una API de SOAP
• Importación de API de SOAP y conversión en REST
• Importación de App Service API
• Importación de una aplicación de contenedor de Azure como una API
• 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 aplicación de Azure Function App
• Importación de una aplicación lógica de Azure.
• Importación de un servicio Service Fabric
• 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