Qué es OpenAPI y por qué debería usarlo

Completado

OpenAPI define una descripción de interfaz estándar e independiente del lenguaje de programación para las API web. Permite que tanto los humanos como las máquinas descubran y comprendan las capacidades de un servicio sin tener que obtener acceso al código fuente, la documentación adicional o inspeccionar el tráfico de la red.

Captura de pantalla de OpenAPI

Al utilizar un documento de OpenAPI que describe una API web, el consumidor puede entender y comunicarse con la API web con un esfuerzo mínimo.

Se puede crear un conector personalizado para cualquier API web siempre que esté descrito correctamente en un documento de OpenAPI. Eso significa que el equipo de desarrollo de fusión de VanArsdel no se limita a crear conectores personalizados para sus aplicaciones de Power Apps a partir de API web hospedadas en Azure API Management.

¿Qué hace el documento de OpenAPI?

El documento de OpenAPI especifica un contrato del área de superficie de la API web. Resume los detalles de implementación reales lejos del consumidor de la API. Eso significa que puede crear rápidamente su aplicación sabiendo a qué métodos llamar y qué devolverán sin tener que preocuparse por cómo se invocan esos métodos.

En la unidad anterior, utilizó Azure API Management para crear un conector personalizado. Al hacerlo, también creó una dependencia en Azure API Management. En otras palabras, si se produce algún cambio en Azure API Management, su conector personalizado debe actualizarse para reflejar el cambio.

Con el documento de OpenAPI, no es necesario que sepa dónde se encuentra la API o si se está ejecutando, porque el documento contiene toda la información que necesita.

Power Apps le permite crear instantáneamente un conector personalizado con este documento de OpenAPI.

Captura de pantalla de

Una vez que cree el conector personalizado a partir del documento de OpenAPI, podrá verlo en su página de Power Apps.

Captura de pantalla del conector personalizado en la página de Power Apps

¿Por qué utilizar un documento de OpenAPI para conectores personalizados?

Utilizar el documento de OpenAPI para la creación de su conector personalizado conlleva muchas ventajas. Sin embargo, los siguientes dos beneficios son los más cruciales para los desarrolladores civiles.

  • Eliminar dependencias: con un documento de OpenAPI, puede crear un conector personalizado usted mismo, sin tener que esperar a que otra persona lo cree por usted desde API Management. Además, cada vez es más común que los equipos de desarrollo profesionales incluyan capacidades de generación de documentos de OpenAPI dentro de la API web. Esto significa que puede descargar el documento de OpenAPI visitando una URL y luego crear el conector personalizado con él.
  • Aumentar la agilidad: el ritmo de desarrollo de su Power App aumenta cuando su equipo de desarrollo de API web puede brindarle un documento OpenAPI. No necesita depender de ellos para nada más que para crear y utilizar un conector personalizado.

Como puede ver en el siguiente diagrama, el documento de OpenAPI no tiene por qué conocer la implementación real de la API web, siempre que el contrato siga siendo el mismo.

Diagrama de OpenAPI sin tener que conocer la API web

Un conector personalizado de un documento de OpenAPI o Azure API Management

Para crear un conector personalizado, puede usar Azure API Management o un documento de OpenAPI. ¿Cuál debería elegir?

Esta tabla contiene algunas comparaciones entre Azure API Management y OpenAPI para conectores personalizados.

Conector Azure API Management Documento de OpenAPI
Control de API Centralizado Distribuido
Capa de estructura de la API Compleja Simple
Capa de seguridad extra No
Control de uso No
Coste adicional No
Complejidad arquitectónica Mayor Menor