@داویدزینmTools
ما مستندات و نرم افزارهای مدیریت ریز سرویس را ایجاد می کنیم
بالای سالها کار با ریز خدمات، ما نکات کلیدی را کشف کرده ایم که باید برای آنها رعایت کنید دید خوب را حفظ کنید و بتواند ریز خدمات را مدیریت کند. در زیر این قوانین ساده را بررسی کنید.
خلاصه
- مستندات رابط API خودکار داشته باشید
- یادداشت های انتشار سند و خدمات مربوطه
- دارندگان خدمات را برای ارتباط بهتر تعریف کنید
- وابستگی های هر سرویس را ثبت کنید
- مصرف کنندگان API خود را پیگیری کنید
- اهداف تغییر خدمات را پیگیری کنید
- ابزاری پاداش برای حل این مشکلات
1. مستندات رابط API خودکار داشته باشید
ابزارهای زیادی برای استفاده وجود دارد تولید می کنند API مستندات از جانب کد. این روش در مقایسه با اسناد دستی API یک برنده واضح است زیرا:
- اسناد دریافت نمی کند منسوخ شده همانطور که اغلب بدون هیچ تلاشی علاوه بر چند خط نظر در کد ، تولید می شود ،
- مقداری ابزار زوج اجازه ساخت درخواست ها بدون تنظیم تمام پارامترهای درخواست در یک ابزار خارجی یا پایانه.
بسته به زبان برنامه نویسی یک سرویس خاص ، کتابخانه های زیادی برای استفاده وجود دارد. من دوست دارم از ابزاری استفاده کنم که مستندات Swagger را تولید می کند و در صورت نیاز می توانم آنها را به Postman وارد کنم.
2. یادداشت های انتشار اسناد و خدمات مربوطه
شرکت ها …