Modeling Microservice Based Applications: Model Lives Inside Code Approach

Abstract

In today's software development, maintaining consistent documentation is crucial for sharing and preserving team knowledge. As projects grow more complex, developers need to quickly understand and maintain code. However, keeping documentation aligned with business logic without unnecessary technical details is challenging. Traditional visualization tools like UML, sequence, and activity diagrams focus on object-oriented approaches and often require manual updates, making them less suitable for event-based systems like microservices. To address these issues, the tool Docupyt was developed using eEPC (Extended Event Process Chains) as the main modeling approach. Docupyt is designed with three key principles: ease of use, simplicity (including only necessary logic), and reactivity (representing event-based systems). eEPC notation helps analyze problems and represent changing logic during development, accommodating fast-changing requirements. It supports both high and low-level process definitions and focuses on business logic without extraneous technical details. Generated directly from code through simple commenting, this approach simplifies updating documentation as the code changes, reducing maintenance costs. Using the design science research method, Docupyt was validated in a case study, demonstrating it is user-friendly and provides adequate detail without being overly technical. Its main advantage is keeping documentation in sync with code logic, easing updates.

Günümüz yazılım geliştirme süreçlerinde, takım içindeki bilginin korunması için dokümantasyona sahip olmak kritik öneme sahiptir. Projeler karmaşıklaştıkça, geliştiricilerin kodu hızla anlaması ve bakımını yapması gerekmektedir. Ancak, belgelerin iş mantığına uygun ve gereksiz teknik detaylar içermeyecek şekilde tutulması zordur. UML, ardıl etkileşim ve aktivite diyagramları gibi geleneksel görselleştirme araçları, nesne yönelimli yaklaşımlara odaklanır ve genellikle manuel güncellemeler gerektirir, bu da onları mikroservisler gibi olay-tabanlı sistemler için daha az uygun hale getirir. Bu sorunları çözmek için, ana modelleme yaklaşımı olarak eEPC'yi (Extended Event Process Chains) kullanan Docupyt aracı geliştirilmiştir. Docupyt, kullanım kolaylığı, sadelik (sadece gerekli mantığı içeren) ve reaktiflik (olay tabanlı sistemleri temsil etme) olmak üzere üç temel ilke ile tasarlanmıştır. eEPC notasyonu, sorunları analiz etmeye ve değişen mantığı geliştirme sürecinde temsil etmeye yardımcı olur, hızlı değişen gereksinimlere uyum sağlar. Dokümantasyonu doğrudan koddan üreten bu yaklaşım, kod değiştikçe belgeleri güncellemeyi kolaylaştırarak bakım maliyetlerini azaltır. Tasarım bilim araştırma yöntemi kullanılarak geliştirilen Docupyt, bir vaka çalışmasında doğrulanmıştır. Ana avantajı, belgeleri kod mantığıyla uyumlu tutarak güncellemeleri kolaylaştırmasıdır.