في هذه المقالة ، سننظر في طريقة لتطوير واجهة برمجة تطبيقات REST المستندة إلى العقود.
عند تطوير واجهة برمجة تطبيقات REST جيدة ، من المهم أن يكون لديك خدمات ميكروية كبيرة. سيساعدك نهج العقد الأول على تطوير عقد جيد قبل تنفيذه. ومع ذلك ، فإنه ليس بهذه البساطة!
سوف تتعلم
- ما هي طريقة العقد الأول لتطوير واجهة برمجة تطبيقات REST؟
- ما هي فوائد نهج العقد الأول؟
- ما هي عيوب نهج العقد الأول؟
- متى تستخدم نهج العقد الأول؟
REST API
هذه هي المقالة الثالثة في سلسلة من المقالات حول REST API:
مفهوم خدمات الويب
هناك عدة أنواع من خدمات الويب ، بما في ذلك REST و SOAP. لكل خدمة هناك:
- مزود الخدمة الذي يقدم الخدمة
- المستهلك من الخدمة التي تستخدمها
يجب على المستهلك معرفة تفاصيل الخدمة المقدمة. لهذا السبب ، يجب إبرام العقد. يحدد عقد الخدمة:
- ما هي خصوصيات وعموميات الخدمة؟
- ما عنوان URL الذي تتوفر به الخدمة؟
- كيفية إرسال إذن؟
نهج العقد الأول
باستخدام نهج "
العقد الأول " (العقد أولاً) ، يمكنك أولاً تحديد العقد ثم تنفيذ الخدمة. لنلقِ نظرة على مثال.
WSDL
لنلقِ نظرة أولاً على استخدام WSDL ، وهي لغة تعريف خدمات الويب. فيما يلي مثال للاستخدام:
يشيع استخدام WSDL مع خدمات الويب SOAP / XML. في هذه الحالة ، عادة ما تحدد:
ما المقصود بالعقد؟
عندما نبدأ بإبرام عقد ، فإننا نحدد WSDL ثم نشاركه مع المستهلك. كل هذا يمكن أن يحدث حتى قبل تقديم الخدمة وإتاحتها.
يخبر العقد المستهلك كيف يتم تبادل الطلبات والردود. بمجرد إبرام العقد ، يمكن لمزود الخدمة العمل على توفير خدمة تتفق مع العقد. يمكن لمستهلك الخدمة العمل على تطوير تطبيق لاستخدامه.
فوائد العقد النهج الأول
يمكن للفرق تطوير بالتوازي
نظرًا لأن الترميز يعتمد على العقود ، يفهم مقدمو الخدمات ومجموعات المستهلكين بوضوح طريقة الاتصال وتفاصيله. لذلك ، يمكن أن تحدث التنمية في وقت واحد.
الفرق تعرف ما يمكن توقعه.
نظرًا لأن الترميز يعتمد على العقد ، فإن فرق المنتجين والمستهلكين لديهم فكرة عن توقعات بعضهم البعض. نتيجة لذلك ، إذا كان اختبار intergroup غير ممكن بسبب معدلات تطور مختلفة ، فيمكن استخدام برنامج كعب الروتين لتصميم سلوك الطرف الآخر بناءً على العقد.
عبر منصة التوافق
نظرًا لأن معلمات الخدمة تعتمد فقط على العقد ، فإن بنية البرنامج الفعلية المستخدمة لتطوير الخدمة لا تهم كثيرًا. قد يستخدم مزود الخدمة ومستهلك الخدمة تقنيات مختلفة.
يسمح بإعادة استخدام المخططات
المخططات المستخدمة لتحديد عقد الخدمة محددة بشكل جيد في WSDL. لذلك ، إذا تكررت أجزاء من الخدمات في خدمات أخرى ، فيمكن أيضًا إعادة استخدام المخططات المقابلة.
مساوئ العقد النهج الأول
تكاليف مقدمة إضافية مطلوبة
ستتمحور معظم هذه التكاليف حول اتفاقية الخدمة. يجب التأكد من أن العقد محدد بوضوح ولا يتغير كثيرًا.
آلية تجديد العقود وتبادلها
أثناء مدة استخدام الخدمة ، إذا قمت بتحديث العقد ، فسيؤثر ذلك على جميع الأطراف المعنية الأخرى. لذلك ، يجب أن تكون هناك آلية مناسبة لنقل التغييرات إلى مختلف المستهلكين.
في هذه المشكلة ، يوجد
فيديو للمؤلف.
ملخص
في هذه المقالة ، ناقشنا نهج العقد الأول في سياق خدمات الويب.
قراءة إضافية
تطوير التطبيقات السريعة باستخدام API أولاً باستخدام Open-API Generatorتطبيق منهجية تصميم API-First