رسم نمودار جریان با openhop و ایجنت
مسیر عبور اطلاعات رو در YAML تعریف کنید و در نمایشگر محلی، مرحلهبهمرحله همراه داده و جزییات ببینید.
رسم نمودار جریان با openhop و ایجنت وقتی مفیده که میخواید حرکت یک درخواست بین چند بخش رو توضیح بدید. این اسکیل شرح شما رو به فایل YAML تبدیل میکنه و با ابزار همراه، نمودار قابل پخش و بررسی در مرورگر میسازه.
مثلا میتونید بخواید مسیر ثبت سفارش، بررسی موجودی و پاسخ پرداخت در سه مرحله دیده بشه و داده عبوری هر ارتباط هم مشخص باشه. بخش پیچیدهتر میتونه نمودار تو در تو داشته باشه تا مخاطب وارد جزییاتش بشه. فایل قابل ویرایش میمونه، اما نمایشگر به سرویس محلی همراه نیاز داره؛ خروجی وعده یک HTML مستقل یا انتشار خودکار نیست.
کاربردها
- توضیح مسیر یک درخواست بین چند سرویس
- ساخت نمودار جریان همراه نمونه داده هر مرحله
- آمادهکردن نمایش مرحلهای برای جلسه فنی
- جداکردن مفهوم هر بخش از اسم واقعی آن
- بازکردن جزییات در یک نمودار تو در تو
- اصلاح ساختار با نگهداشتن فایل YAML
نصب و استفاده
- اسکیل و ابزار npm همراهش رو برای ایجنت دارای دسترسی به فایل و اجرا آماده کنید. یک مسیر سازگار، Node 22.12 یا بالاتر و مرورگره؛ ساخت نمودار محلی به حساب یا کلید سرویس نیاز نداره. نصب، فایلهای مربوط به ایجنت رو هم مینویسه.
- بخشها، ترتیب حرکت، پیام هر مرحله و نمونه داده مجاز رو مشخص کنید. برای نمونه، بخواید پاسخ ناموجودبودن کالا جدا از پرداخت موفق دیده بشه؛ اسمهای واقعی پروژه رو با نوع بخش قاطی نکنید.
- از ایجنت بخواید فایل رو براساس ساختار پشتیبانیشده بسازه و بررسی کنه، سپس آن رو به سرویس محلی بده. پیوند مخصوص همان نمودار رو در مرورگر باز کنید و ترتیب، پیامها و ورود به بخشهای داخلی رو ببینید.
- اصلاحها رو در منبع نگه دارید و تا وقتی به نمایش نیاز دارید، سرویس محلی رو فعال نگه دارید. اطلاعات حساس رو عمومی نکنید؛ بعضی فونتها و آیکنهای انتخابی از اینترنت گرفته میشن.
سوالات متداول
منبع
ساخته Naor Sabag. نام اصلی: openhop، منتشرشده در GitHub با مجوز MIT.
مشاهده در GitHub