Importación y publicación de una API

5 minutos

Para que una API esté disponible mediante una puerta de enlace de API, debe importar y publicar la API.

En el ejemplo de la empresa de zapatos, NorthWind Shoes quiere permitir que determinados asociados puedan consultar el inventario y los niveles de existencias.

Aquí, aprenderá a importar una API en Azure API Management y a cómo hacer que una API esté disponible para los clientes.

API

Una API es una forma estandarizada que tienen las organizaciones de exponer datos específicos a desarrolladores o asociados potenciales. Por ejemplo, en el ejercicio anterior ha creado una API para compartir información sobre productos e inventario.

Para que una API esté disponible, primero es necesario importarla en API Management. Luego, puede:

Usar las herramientas de visualización de la puerta de enlace de API para probar la API.
Administrar el acceso a las API mediante directivas.

Marcos de API

Existen varios marcos y estándares de API. API Management proporciona varias opciones para la importación de las API.

Tipo	Detalles
HTTP	Puede importar una API HTTP con una definición de API en blanco. Luego, puede especificar manualmente todos los parámetros necesarios.
WebSocket	Configure el tránsito a un servicio WebSocket de backend.
GraphQL	Configure el tránsito en un servicio GraphQL de backend o importe un esquema de GraphQL y cree una API de GraphQL sintética con solucionadores de campos personalizados.
OpenAPI	OpenAPI es una especificación que documenta todos los puntos de conexión y operaciones de API de RESTful, y todos los parámetros de entrada y salida. OpenAPI se llamó originalmente Swagger.
WADL	Web Application Description Language es una descripción XML de servicios web basados en HTTP. Es un formato más sencillo y más ligero que WSDL.
WSDL	Web Service Description Language es una descripción XML de cualquier servicio de red, no solo HTTP.

También puede importar las API de varios recursos de Azure del backend.

Tipo	Detalles
Aplicación lógica	Las aplicaciones lógicas se usan para organizar y automatizar los flujos de trabajo y las integraciones con varios orígenes de datos.
App Service	Una API que se hospeda dentro de un servicio de aplicaciones en Azure.
Aplicación de función	Código sin servidor que se puede llamar mediante desencadenadores.
Instancia de Container Apps	Contenedores sin servidor para microservicios.

Importación de una API

Existen varias maneras de importar una API en Azure API Management.

Mediante Azure Portal, seleccione API y, luego, + Agregar API. Para comenzar, seleccione el tipo de API que quiere importar.

Screenshot of Azure portal showing API Management service with the APIs section highlighted and selected.

A continuación, proporcione un vínculo a la especificación de API como una dirección URL o un archivo, y un nombre para la API. Este es un ejemplo de una importación de OpenAPI.

Screenshot of create from OpenAPI specification import settings with OpenAPI specification and display name fields highlighted.

Azure Portal no es la herramienta más eficaz para importar y configurar una gran cantidad de API. A medida que escale verticalmente API Management, necesitará otras herramientas, como la CLI de Azure, Azure Resource Manager o las plantillas de Bicep, o Azure PowerShell. Por ejemplo, puede usar cmdlets de Azure PowerShell para implementar puertas de enlace de API, definir y configurar productos, importar API y administrar usuarios y suscripciones.

Visualización

Puede usar la puerta de enlace de API como una manera de visualizar cómo se procesan los datos mediante las API importadas. Puede interactuar con los conjuntos de datos y pasar parámetros mediante las API.

Si es administrador, puede visualizar las API en Azure Portal.

Screenshot of Azure portal API configuration showing a highlighted GET request test on an imported API.

Directivas

Las directivas proporcionan eficaces funcionalidades para cambiar el comportamiento de una API mediante la configuración. Existen como una colección de declaraciones que se ejecutan secuencialmente en la solicitud o respuesta de una API.

Las configuraciones conocidas son:

Conversión de XML a JSON
Limitación de la frecuencia de llamadas para restringir el número de llamadas entrantes.
Establecimiento de encabezados entrantes y salientes.

Usará Azure Portal para aplicar diferentes directivas a las API. Las directivas se pueden ver en la pestaña Diseño.

Screenshot of Azure portal showing API configuration for all operations with base policies highlighted for inbound, outbound, and backend sections.

También puede usar la pestaña Diseño para agregar nuevas directivas.

Screenshot of Azure portal showing inbound policy options for API configuration.

Producto

Un producto es una colección de API. Se pueden asignar API a más de un producto. Por ejemplo, puede que quiera que un producto, NorthWindShoesPartners, exponga dos API a sus asociados:

Producto	NorthWindShoesPartners
API 1	Inventario
API 2	Planeamiento

Para los proveedores, puede que solo quiera exponer una API:

Producto	NorthWindShoesSuppliers
API 1	Inventario
API 2

Se asignan directivas para que los productos puedan tener diferentes reglas de acceso, cuotas de uso y condiciones de uso. Por tanto, si quiere que los asociados y proveedores tengan diferentes derechos de acceso a su API de inventario, asigne la API a dos productos diferentes.

Usará Azure Portal para asociar las API con un producto.

Screenshot of Azure portal showing API Management with products section highlighted.

En todos los planes de tarifa, excepto Consumo, hay dos productos predeterminados: Starter y Unlimited. El producto Unlimited está diseñado para la administración de API de producción, dado que no tiene ninguna restricción sobre el número de API asociadas. Puede crear tantos nuevos productos como necesite. El producto Starter tiene un límite de cinco llamadas API por minuto y un máximo de 100 llamadas API por semana.