CONTRACT-ORIENTED MODELLING OF MICROSERVICE ARCHITECTURE FOR HIGH-LOAD SYSTEMS IN A UML-LIKE ENVIRONMENT

Authors

DOI:

https://doi.org/10.32689/maup.it.2025.2.20

Keywords:

contract-oriented modelling, microservice architecture, high-load systems, UML-like environment, OpenAPI, JSON Schema, Swagger

Abstract

The study aims to develop and substantiate a contract-oriented modelling method for the microservice architecture of high-load software systems within a specialised UML-like web environment. The proposed approach merges the advantages of visual design and formal interface specification: JSON contract fragments are embedded directly into the arrows representing component interactions on the diagrams. This provides an early, unambiguous and machine-readable fixation of API agreements, minimises the gap between the design model and service implementation, and reduces documentation- maintenance costs.Methodology. The method includes an algorithm that automatically converts the embedded JSON contracts into OpenAPI v3 specifications, which can then be used to generate server stubs, client libraries, integration tests or configure API gateways. A prototype of the environment was implemented with a TypeScript + Node.js stack, combining Canvas/WebGL diagram rendering with a server-side OpenAPI generator. Experimental evaluation on three representative scenarios (product catalogue, order service, payment service) compared the proposed approach with a classical UML-based process that lacks contracts. The results demonstrated a 28 % reduction in average API alignment time, a 33 % decrease in integration defects and a 22 % improvement in documentation coverage. Scientific novelty. A distinctive advantage of the tool is its support for «living» documentation: any change in the diagram is instantly mirrored in the updated contract, ensuring synchronisation between the model and service source code throughout the software life-cycle. Future research will focus on integrating the environment with real-time contract-tracing systems, extending support for asynchronous protocols (AsyncAPI) and developing metrics for assessing the complexity of contract dependencies across an enterprise-scale service portfolio.Conclusions. The proposed contract-oriented modelling method within a UML-like environment has proven effective for high-load microservice systems. Automatic OpenAPI generation and live documentation support shorten API alignment time, reduce integration defects and increase documentation coverage. The tool maintains continuous consistency between the architectural model and service code, thereby enhancing software quality and simplifying its evolution and maintenance.

References

Ed-douibi H., Cánovas J. L., Bordeleau F., Cabot J. WAPIml: Towards a Modeling Infrastructure for Web APIs. Proc. of the 22nd ACM/IEEE Int. Conf. on Model Driven Engineering Languages and Systems (MODELS 2019 Companion). 2019. P. 748–752.

Node.js. Офіційний веб-сайт URL: https://nodejs.org (дата звернення: 23.06.2025).

Object Management Group (OMG). Unified Modeling Language (UML) Specification Version 2.5.1. URL: https://www.omg.org/spec/UML/2.5.1 (дата звернення: 23.06.2025).

Rademacher F., Wizenty P., Sorgalla J., Sachweh S., Zündorf A. Model-Driven Engineering of Microservice Architectures – The LEMMA Approach. Ernst Denert Award for Software Engineering 2022. – Cham: Springer, 2024. P. 105–147.

Specmatic – Contract Driven Development. Офіційний веб-сайт. URL: https://specmatic.io (дата звернення: 23.06.2025).

StarUML. Офіційний веб-сайт. URL: http://staruml.io (дата звернення: 23.06.2025).

Swagger (OpenAPI) – офіційний веб-сайт. URL: https://swagger.io (дата звернення: 23.06.2025).

SwaggerHub Documentation. OpenAPI 3.0 Tutorial. URL: https://support.smartbear.com/swaggerhub/docs/en/get-started/openapi-3-0-tutorial.html (дата звернення: 23.06.2025).

Visual Paradigm. Офіційний веб-сайт. URL: https://www.visual-paradigm.com (дата звернення: 23.06.2025).

Published

2025-09-23

How to Cite

ПАНАСЮК, Б., & БАБЮК, Н. (2025). CONTRACT-ORIENTED MODELLING OF MICROSERVICE ARCHITECTURE FOR HIGH-LOAD SYSTEMS IN A UML-LIKE ENVIRONMENT. Information Technology and Society, (2 (17), 136-140. https://doi.org/10.32689/maup.it.2025.2.20