Design-first framework for REST API development in Erlang

Abstract

[Abstract]: The abstraction layer provided by APIs allows heterogeneous systems to communicate easily regardless of their underlying technology. Given its essentiality, organisations devote large amounts of effort to implementing, validating, and maintaining their APIs. API-driven methodologies emerge to improve API development processes. Among them, the design-first methodology prioritises agreeing on a detailed API specification before the implementation step begins. This, unlike a code-first methodology, allows the automation of several tasks that depend on the interface type specification. In this work, a design-first framework for the development of REST APIs in the Erlang programming language is presented. The implemented tools allow exposing runtime reconfigurable HTTP servers with automated request validation and routing based on OpenAPI 3.0 specifications. Furthermore, the framework includes a tool for the automatic testing of the implementation with respect to the specification using property-based testing techniques. As a method of evaluating the produced software, the work includes a comparative analysis against similar tools.

[Resumo]: A capa de abstracción que proporcionan as APIs permite que sistemas heteroxéneos se comuniquen de forma sinxela con independencia da súa tecnoloxía subxacente. Dada a súa esencialidade, as organizacións dedican grandes cantidades de esforzo á implementación, validación e mantemento das súas APIs. Co obxectivo de mellorar os procesos de desenvolvemento das APIs, xorden as metodoloxías API-driven. De entre elas, a metodoloxía design-first prioriza acordar unha especificación da API detallada antes de comezar a fase de implementación. Isto, ao contrario que nunha metodoloxía code-first, permite a automatización de diversas tarefas que dependen da especificación de tipos da interface. Neste traballo, preséntase un framework design-first para o desenvolvemento de APIs REST na linguaxe de programación Erlang. As ferramentas implementadas permiten expoñer servidores HTTP reconfigurables en tempo de execución con validación e encamiñamento automático de peticións a partir de especificacións OpenAPI 3.0. Ademais, o framework inclúe unha ferramenta para a validación automática da implementación con respecto á especificación empregando técnicas de probas baseadas en propiedades. Como método de avaliación do software producido, o traballo inclúe unha análise comparativa con ferramentas similares.