محمد مهدوی کیا
محمد مهدوی کیا
خواندن ۱ دقیقه·۱ سال پیش

مستندسازی میکروسرویس ها با Microservice Canvas

یک قالب نمونه استاندارد برای یک بوم میکروسرویس
یک قالب نمونه استاندارد برای یک بوم میکروسرویس

در مبحث معماری بر مبنای میکروسرویس‌ها، مساله‌ی مستندسازی آن‌ها مطرح است.

معمولا در شرکت‌های نرم افزاری جهت مستندسازی کلاس‌ها از کارت‌هایی تحت عنوان CRC که در توسعه‌ی شئی‌گرایی مورد استفاده قرار میگیرد استفاده می شود.

در توسعه‌ی مبتنی بر میکروسرویس ما کارت هایی داریم که Microservice Canvas یا همان "بوم میکروسرویس" نام دارد. در این کارت‌ها تمام ویژگی‌های ممکن و عمومی یک میکروسرویس بعنوان سندی فنی از مجموع اسناد فنی پروژه عموما توسط توسعه دهنده‌گان تکمیل می‌شود تا بعدا توسط تیم مستندساز تبدیل به یک سندفنی معتبر برای محصول نهایی شود.

معمولا در یک کارت استاندارد Microservice Canvas موارد زیر تکمیل می شود:

نام سرویس، توضیحات،قابلیت ها،جزئیات API شامل تمام توابع کاربردی، کوئری‌ها و رویدادها، دامین بیزینس و مواردی از این دست.

تکمیل کارت‌های Canvas به ازای هر سرویس در جریان توسعه ی هر میکروسرویس، روند مستندسازی محصول نهایی را بسیار سریعتر و دقیتر پیش خواهد برد.


میکروسرویسنرم افزارcanvasmicroserviceتوسعه نرم افزار
توسعه دهنده‌ی نرم‌افزار
شاید از این پست‌ها خوشتان بیاید