لقد بنيت أداة تقوم بإصلاح الكود التابع تلقائيًا عند تغيير واجهة برمجة التطبيقات

في الأنظمة الموزعة وarchitectures الخدمات المصغرة، تخلق تغييرات واجهة برمجة التطبيقات تأثيرًا متسلسلًا يمكن أن يعطل فرقًا متعددة. تقوم بتعديل حقل في تعريف protobuf أو نقطة نهاية REST الخاصة بك، ودفع التغيير، وفجأة تقضي الأيام التالية في التنسيق مع الفرق التابعة لتحديث كودها. هذا الاحتكاك يبطئ التكرار وينشئ ربطًا بين الفرق التي يجب أن تعمل بشكل مستقل في الوضع المثالي.

مشكلة الانتشار

عندما تعمل واجهة برمجة التطبيقات كعقد بين الخدمات، يحمل أي تعديل خطر كسر المستهلكين. تعامل الأساليب التقليدية تغييرات واجهة برمجة التطبيقات كحدث يدوي منسق: تتواصل الفرق من خلال RFCs وسجلات التغيير والاجتماعات. في حين أن الحوكمة لها مكانها، تصبح عنق الزجاجة في التنسيق اليدوي كابحًا كبيرًا على سرعة التطوير، خاصة مع نمو عدد الخدمات التابعة.

تتفاقم التحدي في بيئات متعددة اللغات حيث تستخدم فرق مختلفة لغات وأطر عمل مختلفة. قد يتطلب إعادة تسمية حقل واحد في ملف proto تحديثات عبر خدمات Go ومستهلكي Python وعملاء JavaScript في وقت واحد. بدون مساعدة آلية، يصبح تتبع ونشر هذه التغييرات مصدر قلق بدوام كامل.

استراتيجيات التخفيف الموجودة

طورت الصناعة عدة استراتيجيات لتقليل ألم تطور واجهة برمجة التطبيقات. التطوير القائم على المخطط باستخدام أدوات مثل مولدات OpenAPI أو إضافات protoc يخلق مصدرًا واحدًا للحقيقة يتم اشتقاق SDKs العملاء وstubs الخادم منه. عند التنفيذ بشكل متسق، يضمن هذا النهج أن يظل المنتجون والمستهلكون متزامنين على مستوى النوع.

تتيح أطر عمل اختبار العقد مثل Pact للفرق التحقق من توافق واجهة برمجة التطبيقات دون تشغيل بيئات تكامل كاملة. تكتشف هذه الأدوات التغييرات المكسرة أثناء التطوير وليس في الإنتاج، مما ينقل التعليقات في وقت مبكر من الدورة.

يمكن لـ API gateways وservice meshes تنفيذ استراتيجيات إصدار تسمح بإطلاق تدريجي. تسمح عمليات النشر الزرقاء والخضراء وعلامات الميزات للفرق بشحن التغييرات خلف التبديلات، مما يمنح المستهلكين وقتًا للتكيف دون تنسيق متزامن.

وعود ومخاطر أدوات الإصلاح التلقائي

تسعى الحلول الأكثر طموحًا لأتمتة عملية الإصلاح نفسها. الفكرة جذابة: اكتشاف تغيير واجهة برمجة التطبيقات، وتحليل تأثيره على قواعد الكود التابعة، وتطبيق التصحيحات تلقائيًا. تستكشف بعض الأدوات التجريبية هذا المجال من خلال تحليل graphs الاعتماد، وتحديد مواقع الاستدعاء المتأثرة بتغييرات المخطط، وإنشاء patches.

ومع ذلك، يواجه الإصلاح التلقائي تحديات أساسية. الكود أكثر من الأنواع والهياكل - يحمل نية ومنطق أعمال وافتراضات لا يمكن لمحلل نحوي بحت فهمها بسهولة. قد يتطلب إعادة تسمية حقل ليس فقط تحديث استدعاءات accessor ولكن أيضًا مراجعة أسماء المتغيرات والتعليقات والتوثيق الذي يشير إلى المعرف القديم.

الأهم من ذلك، التغييرات التلقائية معرضة لإدخال أخطاء دقيقة. قد تقوم أداة بتحديث استدعاء أسلوب بشكل صحيح لكن تفشل في مراعاة معالجة الأخطاء المحددة للمستهلك أو منطق إعادة المحاولة الذي اعتمد على السلوك القديم. تتطلب patches آلية التحقق الدقيق قبل التطبيق.

بناء طبقة التجريد الصحيحة

بدلاً من محاولة patch كود عشوائي، نهج أكثر متانة يفصل تعريفات الواجهة عن تنفيذها. من خلال الاحتفاظ بعقود واجهة برمجة التطبيقات بتنسيقات مقيدة الإصدار وقابلة للقراءة آليًا وإنشاء جميع الروابط الخاصة باللغة من تلك التعريفات، تلغي الفرق المزامنة اليدوية بالكامل. تؤدي التغييرات على العقد إلى إعادة الإنشاء بدلاً من التحديثات المكتوبة يدويًا.

تعمل هذه الاستراتيجية بشكل أفضل عند دمجها مع اصطلاحات قوية حول التوافق العكسي. إن إضافة حقول اختيارية، وعدم إزالة الحقول دون دورات إلغاء، واتباع انضباط إصدار دلالي يقلل من تكرار التغييرات المكسرة التي تتطلب تنسيقًا.

الأداة المثالية تقف على الحدود بين توليد الكود والتحليل الثابت - قادرة على اكتشاف التغييرات المكسرة قبل دمجها، وإنشاء نصائح الترحيل عند الضرورة، وتتبع الفرق التي تبنّت إصدارات واجهة برمجة التطبيقات والتي.

قراءة إضافية: https://dev.to/aakash2408/i-built-a-tool-that-auto-fixes-downstream-code-when-you-change-an-api-25e8