Gobierno de APIs, implementación y experimentación con API-First y OpenAPI en el proyecto P2P energía transactiva

Abstract

RESUMEN : EPM es una empresa de servicios públicos domiciliarios con una responsabilidad social y ambiental. EPM imprime los más altos estándares internacionales de calidad a los servicios que presta: energía eléctrica, gas por red, agua y saneamiento. La gestión de APIs es la estrategia elegida para la interacción entre aplicaciones en EPM, asegurando el intercambio de información y funcionalidades en los sistemas internos de la empresa y con sistemas de terceros. A partir de lo anterior, la implementación de buenas prácticas para el gobierno de APIs, junto con el enfoque de desarrollo de APIs, API-First, son claves para poder lograr la estandarización de estas y, por lo tanto, reducir tiempo, complejidad y costo de desarrollo de las APIs, además de aumentar su calidad y promover su economía. La implementación del enfoque API-First se llevó a cabo mediante la experimentación en el proyecto P2P energía transactiva en donde, haciendo uso de Spectral, herramienta conocida como API-linter, en el proceso de validación de contratos de APIs. Gracias a esta herramienta se logró obtener porcentajes entre el 95% y el 99.9% de reducción de tiempos de validación. Herramienta que a su vez se trajo como lineamiento en la estrategia de gobierno de APIs en EPM.

ABSTRACT : EPM is a home public services company with a social and environmental responsibility. EPM has the highest international quality standards for the services it provides: electricity, gas, water and sanitation. API management is the chosen strategy for application interaction, assuring information and functionalities exchange between internal and external systems. From the above, implementing good practices in API government, along with the API development approach, API-First, are key ways to standardize EPM’s API, therefore, reduce time, complexity, and cost of developing API as well as increasing quality and promote their economy. The API-First approach implementation was carried out by experimenting in the P2P transactive energy project and using Spectral, a tool known as API-linter, in the API contract validation process. By using Spectral, the validation time taken in the validation process was reduced between 95% and 99.9%. This tool also was used as a guideline in the EPM’s API governance strategy.