Documenting Microservice Integration with MSAdoc
Microservices are a popular software architectural style that decomposes a large application into smaller services. These microservices integrate at runtime to deliver business value to the users.
With an increasing number of microservices, software projects become more difficult to manage. Specifically, maintaining consistent and up-to-date documentation becomes a challenge that can significantly affect the integration efforts in such projects.
In this article, we present MSAdoc, an open source tool that helps to prevent documentation from going out-of-date quickly. The tool (1) enables decentralized documentation close to the source code of each microservice and those who have to document it, (2) aggregates documentation centrally across individual microservices to make the documentation accessible in one place and generate higher-order documentation, while (3) supporting technological heterogeneity by relying on the technology-agnostic JSON format.
Using a tool like MSAdoc that implements several best practices, practitioners can accommodate the decentralized nature of microservice-based projects and alleviate the problem of maintaining central documentation that quickly becomes outdated.
Sat 21 JunDisplayed time zone: Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna change
16:00 - 17:30 | Session9: AloT & MicroservicesResearch Track / Tool Demonstration Track at Cosmos 3C Chair(s): Qingkai Shi Nanjing University | ||
16:00 15mTalk | EnvGuard: Guaranteeing Environment-Centric Safety and Security Properties in Web of Things System Research Track Bingkun Sun Fudan University, Jialin Ren Fudan University, Juntao Luo Fudan University, Liwei Shen Fudan University, Yongqiang Lu Fudan University, Qicai Chen Fudan University, China, Zhen Dong Fudan University, Xin Peng Fudan University | ||
16:30 15mTalk | Privacy-Preserving Authentication Scheme for V2G in social IoT Based on Certificateless Aggregate Signatures Research Track Zhuoqun Xia Changsha University of Science and Technology, Xin Wang Changsha University of Science and Technology | ||
16:45 15mTalk | To Split or to Merge? Exploring Multi-modal Data Flexibly for Failure Classification in Microservices Research Track Xiuhong Tan Changsha University of Science and Technology, China, Tongqing Zhou National University of Defense Technology, China, Yuan Yuan National University of Defense Technology, China, Shiming He Changsha University of Science and Technology, China, Yuqi Li National Supercomputer Center in Tianjin, Jian Zhang National Supercomputer Center in Tianjin | ||
17:00 15mTalk | Dynamic Microservice Resource Optimization Management Based on MAPE Loop Research Track Lu Wang Xidian University, Xu Fan Xidian University, Yaxiao Li , Quanwei Du Xidian University, Jialuo She Xidian University, Qingshan Li Xidian University | ||
17:15 10mTalk | Documenting Microservice Integration with MSAdoc Tool Demonstration Track |
Cosmos 3C is the third room in the Cosmos 3 wing.
When facing the main Cosmos Hall, access to the Cosmos 3 wing is on the left, close to the stairs. The area is accessed through a large door with the number “3”, which will stay open during the event.