Compartir a través de

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

Requisitos previos

Vaya a la instancia de API Management.

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

    Captura de pantalla que muestra los servicios de API Management en los resultados de la búsqueda.

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

    Captura de pantalla que muestra una instancia de API Management en la página servicios de API Management.

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:

    Captura de pantalla de la creación de una API a partir de una descripción de OData en el portal.

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

    Captura de pantalla que muestra las funciones y conjuntos de entidades de OData.

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

    Captura de pantalla que muestra la ubicación del comando Editar.

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

    Captura de pantalla del editor de esquemas de una API de OData.

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.

    Captura de pantalla que muestra el comando Test.

  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.

Anexión de otras API

Puede crear una API fuera de las API expuestas por diferentes servicios, entre las que se incluyen:

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

Nota

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

Para anexar una API a una API existente:

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

    Recorte de pantalla que muestra la página servicios de API Management.

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

    Recorte de pantalla que muestra la selección de las API en la página Información general.

  3. Seleccione los puntos suspensivos (...) junto a la API que desea anexar a otra API.

  4. Seleccione Importar en el menú desplegable:

    Recorte de pantalla que muestra el comando Importar.

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

Contenido relacionado