Importación de una API de OData

SE APLICA A: todos los niveles de API Management

En este artículo se muestra cómo importar un servicio compatible con OData como una API en API Management.

En este artículo aprenderá a:

• Importación de una descripción de metadatos de OData mediante Azure Portal
• Administración del esquema de OData en el portal
• Protección de la API de OData

Nota

La importación de un servicio de OData como API a partir de su descripción de metadatos está en versión preliminar.

Requisitos previos

• Una instancia de API Management Si aún no tiene una, realice el inicio rápido siguiente: Creación de una instancia de Azure API Management.

• Un servicio expuesto como OData v2 o v4.

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 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, seleccione el menú contextual (...) junto a un conjunto de entidades o función, y 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ú izquierdo, seleccione API> API de OData.

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

   

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

Protección de la API de OData

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

Anexión de otras API

Puede crear una API a partir de las API expuestas por distintos servicios, como los siguientes:

• Una especificación de OpenAPI
• Una API SOAP
• GraphQL API
• Una aplicación web hospedada en Azure App Service
• Aplicación de función de Azure
• Azure Logic Apps
• Azure Service Fabric

Para anexar una API distinta a la API existente, siga estos pasos.

Nota

Al importar otra API, las operaciones se anexan a la API actual.

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

   

2. Seleccione API en la página Información general o en el menú de la izquierda.

   

3. Haga clic en ... junto a la API a la que desea anexar otra API.

4. Seleccione Importar en el menú desplegable.

   

5. Seleccione un servicio desde el que se va a importar una API.

   

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