Волушкова В.Л., Волушкова А.Ю. —
Единый формат спецификации в качестве API-артефакта микросервиса при использовании API-First
// Программные системы и вычислительные методы. – 2022. – № 4.
– С. 54 - 62.
DOI: 10.7256/2454-0714.2022.4.39235
URL: https://e-notabene.ru/itmag/article_39235.html
Читать статью
Аннотация: Объектом исследования являются протоколы взаимодействия (API - Application Programming Interface) микросервисов. API микросервисов является важным объектом разработки, т.к. микросервисы создаются разными командами разработчиков и, не смотря на это, могут быть зависимы друг от друга. Для построения единой системы взаимодействия микросервисов использована методология синхронизации протоколов общения серверных приложений API-First. Целью работы является создание метода разработки API микросервисов серверных java-приложений с использованием библиотек spring. Метод основывается на том, что API декларируется как главная часть разработки микросервисных приложений и поэтому создается на начальном этапе проектирования. Предложен подход, основанный на едином API микросервисов и технике тестирования TDD, повышающий эффективность управления разработкой серверных java-приложений. API микросервисов создается с использованием спецификации в качестве API-артефакта. Разработанная методика позволяет: использовать созданный API другой командой независимо от языка проекта; увеличить производительность команд разработки; качественно документировать методы и модели; уменьшить объем ручного написания программ, т.к. код генерируется автоматически из спецификации; выявить ошибки дизайна API раньше, чем в традиционном подходе к проектированию (code-frist) за счет применения TDD и работы с API до его реализации.
Abstract: The object of research is the interaction protocols (API - Application Programming Interface) of microservices. The microservices API is an important development object because each microservice can be a client for any other microservice and be created by a separate team. To build a unified system of interaction between microservices, the API-First methodology for synchronizing communication protocols for server applications was used. The aim of the work is to create a way to develop API microservices of server java applications using spring-boot, spring-web, openapi-generator, springdoc libraries. The method is based on the fact that the API is the most important part of the product and therefore is created at the initial design stage. An approach based on a single microservices API and TDD testing technique is proposed, which increases the efficiency of managing the development of server-side java applications. The microservices API is built using the specification as the API artifact. The developed technique allows: use the created API by another team, regardless of the development language; increase the productivity of development teams; to carry out a qualitative description of methods and models; reduce the amount of routine code by generating code from the specification; identify API design errors earlier than with the standard development approach (API after implementation) by applying TDD and working with the API before it is implemented.