Compartir a través de


Importación de una especificación OpenAPI

SE APLICA A: Todos los niveles de API Management

En este artículo se muestra cómo importar una API de back-end de "Especificación de OpenAPI" que reside en https://conferenceapi.azurewebsites.net?format=json. Esta API de back-end la proporciona Microsoft y se hospeda en Azure. El artículo también muestra cómo probar la API de APIM.

En este artículo aprenderá a:

  • Importación de una especificación de OpenAPI mediante Azure Portal, la CLI de Azure o Azure PowerShell
  • Prueba de la API en Azure Portal

Nota

Las limitaciones de importación de una API se documentan en Restricciones de importación de API y problemas conocidos.

Requisitos previos

Importación de una API de back-end

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

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

  3. En Crear a partir de la definición, seleccione OpenAPI.

    Captura de pantalla de la creación de una API a partir de una especificación de OpenAPI en el portal.

  4. Escriba los valores de la API. Puede establecer los valores durante la creación o luego accediendo a la pestaña Ajustes. Los valores de configuración se explican en el tutorial Importación y publicación de la primera API.

  5. Seleccione Crear.

Prueba de la nueva API en el portal

Se puede llamar a las operaciones directamente desde el portal, lo que proporciona a los administradores una forma cómoda de ver y de probar las operaciones de una API.

  1. Seleccione la API que creó en los pasos anteriores.

  2. Seleccione la pestaña Prueba.

  3. Seleccione una operación. La página muestra los campos de parámetros de consulta y los campos para los encabezados.

    Nota

    En la consola de prueba, API Management rellena automáticamente un encabezado Ocp-Apim-Subscription-Key y configura la clave de suscripción de la suscripción de acceso completo integrada. Esta clave permite el acceso a todas las API de la instancia de API Management. Opcionalmente, se puede mostrar el encabezado Ocp-Apim-Subscription-Key si se selecciona el icono de ojo situado junto a la Solicitud HTTP.

  4. En función de la operación, escriba los valores de los parámetros de consulta, los valores de encabezado o el cuerpo de la solicitud. Seleccione Enviar.

    Cuando la prueba se realiza correctamente, el back-end responde con un código de respuesta HTTP correcto y algunos datos.

    Sugerencia

    De forma predeterminada, la consola de prueba envía una solicitud al proxy CORS de API Management, que reenvía la solicitud a la instancia de API Management, que la reenvía al back-end. Este proxy usa la dirección IP pública 13.91.254.72 y solo puede acceder a los puntos de conexión públicos. Si desea enviar una solicitud directamente desde el explorador al servicio API Management, seleccione Omitir proxy CORS. Use esta opción si desea usar la consola de prueba y la puerta de enlace de API Management está aislada de red o no permite el tráfico desde el proxy CORS.

Para depurar una API, consulte Tutorial: Depuración de las API con el seguimiento de solicitudes.

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.

    Vaya a la instancia de Azure API Management.

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

    Selección de las API

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

  4. Seleccione Importar en el menú desplegable.

    Selección de Importar

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

    Seleccionar servicio

Validación con una especificación de OpenAPI

Puede configurar las directivas de validación de API Management para validar solicitudes y respuestas (o elementos de ellos) en el esquema en una especificación de OpenAPI. Por ejemplo, use la directiva validate-content para validar el tamaño o el contenido de una solicitud o cuerpo de respuesta.

Pasos siguientes