RAML (برنامج)

لغة نمذجة واجهات برمجة التطبيقات RESTful ( RAML ) هي لغة مبنية على YAML لوصف واجهات برمجة التطبيقات الثابتة (وليس واجهات برمجة تطبيقات REST). ^{[ 2 ]} توفر هذه اللغة جميع المعلومات اللازمة لوصف واجهات برمجة التطبيقات في المستوى الثاني من نموذج نضج ريتشاردسون . على الرغم من تصميمها مع مراعاة واجهات برمجة تطبيقات RESTful، إلا أن RAML لا تستطيع وصف واجهات برمجة التطبيقات التي تلتزم بجميع قيود REST (لا يمكنها وصف واجهة برمجة تطبيقات تلتزم بـ HATEOAS ، على وجه الخصوص). تشجع RAML على إعادة الاستخدام، وتُمكّن من اكتشاف الأنماط ومشاركتها، وتهدف إلى ظهور أفضل الممارسات بناءً على الجدارة. ^{[ 3 ]}

طُرحت لغة RAML لأول مرة عام 2013. وقد وضع مواصفاتها الأولية كلٌ من أوري ساريد، وإيميليانو ليسيندي، وسانتياغو فاكاس، وداميان مارتينيز، وحظيت بدعم من رواد التكنولوجيا مثل MuleSoft وAngularJS وIntuit وBox وPayPal وProgrammable Web وAPI Web Science وKin Lane وSOA Software وCisco. ^{[ 4 ]} ويتولى فريق عمل RAML إدارة عملية التطوير. ^{[ ٥ ]} يضم فريق العمل الحالي الموقعين قادة تقنيين من MuleSoft (أوري ساريد، المدير التقني)، و AngularJS (ميسكو هيفري، مؤسس المشروع)، وIntuit (إيفان لازاروف، كبير مهندسي المؤسسة)، و Airware (بيتر ريكسر، مدير المنتج - منصة المطورين)، و Programmable Web and API Science (جون موسر، المؤسس)، و SOA Software (توني غولوتّا، مدير التطوير)، و Cisco (جايديب سوبيدار، مدير أول، إدارة المنتجات - مجموعة حلول تكامل التطبيقات)، و VMware (كيفن دوفي، مهندس أول في MTS)، و Akamai Technologies (روب داينو، مدير هندسة منصة OPEN API من Akamai)، و Restlet (جيروم لوفيل، المدير التقني والمؤسس). RAML هي علامة تجارية مسجلة لشركة MuleSoft. ^{[ ٦ ]}

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

هناك عدد من الأسباب التي جعلت لغة RAML تتجاوز كونها لغة خاصة بمورد واحد وتثبت أنها مثيرة للاهتمام لمجتمع API الأوسع: ^{[ 7 ]}

• تم طرح لغة RAML كمصدر مفتوح، إلى جانب أدوات ومحللات للغات الشائعة. ستشرف لجنة توجيهية من ممارسي واجهات برمجة التطبيقات وتجربة المستخدم على تطوير RAML، وهناك نظام بيئي ناشئ من أدوات الطرف الثالث قيد التطوير حول RAML ^{[ 8 ].}
• بدأت شركة MuleSoft في الأصل باستخدام Swagger (المعروف الآن باسم مواصفات OpenAPI )، لكنها قررت أنه الأنسب لتوثيق واجهات برمجة التطبيقات الموجودة، وليس لتصميم واجهات برمجة تطبيقات جديدة من الصفر. وقد تطورت لغة RAML استجابةً للحاجة إلى دعم تصميم واجهات برمجة التطبيقات مسبقًا بلغة موجزة وسهلة الاستخدام ^{[ 9 ].}
• غالبًا ما تكون أوصاف واجهات برمجة التطبيقات (APIs) مطولة ومتكررة، مما قد يجعل فهمها واستخدامها صعبًا، ويبطئ من تبنيها. وقد قدمت لغة RAML ميزات لغوية تدعم الملفات المهيكلة والتوريث، مما يعالج المخاوف المشتركة ^{[ 10 ].}

تأسست منظمة جديدة، برعاية مؤسسة لينكس ، تُسمى مبادرة واجهة برمجة التطبيقات المفتوحة (Open API Initiative)، عام ٢٠١٥ بهدف توحيد وصف واجهات برمجة تطبيقات HTTP. وكان من بين الأعضاء المؤسسين عدد من الشركات، منها سمارت بير ، وجوجل ، وآي بي إم ، ومايكروسوفت . ^{[ ١١ ] [ ١٢ ]} وقد تبرعت سمارت بير بمواصفات Swagger للمجموعة الجديدة. كما تدرس المجموعة حاليًا استخدام RAML وAPI Blueprint. ^{[ ١٣ ] [ ١٤ ]}

هذا مثال لملف RAML. وكما هو الحال مع YAML، يُظهر التنسيق التداخل.

#%RAML 0.8العنوان : واجهة برمجة تطبيقات الموسيقى العالميةbaseUri : http://example.api.com/{version}الإصدار : v1سمات :- مُصفّحة :معلمات الاستعلام :الصفحات :الوصف : عدد الصفحات المطلوب إرجاعهاالنوع : رقم- مؤمَّن : !include http://raml-example.com/secured.yml/أغاني :هو : [ مُرقّم ، مؤمّن ]يحصل :معلمات الاستعلام :النوع :الوصف : تصفية الأغاني حسب النوعبريد :/{songId} :يحصل :الردود :200 :جسم :application/json :المخطط : |{ "$schema": "http://json-schema.org/schema","النوع": "كائن،""الوصف": "أغنية كلاسيكية"،"ملكيات": {"العنوان": { "النوع": "سلسلة نصية" },"artist": { "type": "string" }},"مطلوب": [ "العنوان", "الفنان" ]}application/xml :يمسح :الوصف : |ستؤدي هذه الطريقة إلى *حذف* أغنية **فردية**

بعض النقاط البارزة:

• السطر 7، 12: يُعرّف السمات، ويتم استدعاؤها في أماكن متعددة
• السطر 12: ملف تضمين
• السطران 13 و14: تعريف نوع بيانات "مورد" "/songs"؛ يستخدم سمات مُعرَّفة مسبقًا.
• الأسطر 15 و19 و37: تُعرّف طرق HTTP
• السطر 25، 36: أنواع MIME .

• أبيجي
• ميول سوفت
• بوابة واجهة برمجة تطبيقات AWS من AWS (عبر أداة استيراد بوابة واجهة برمجة تطبيقات AWS )
• أكانا
• ريسليت

علاوة على ذلك، يمكنك تحويل مواصفات RAML الخاصة بك إلى OpenAPI أو API Blueprint باستخدام APIMATIC ، مما يتيح لك استخدام بوابات API إضافية.

• مواصفات OpenAPI
• ميول سوفت
• نقل الدولة التمثيلية
• YAML
• واجهة برمجة تطبيقات جافا لخدمات الويب RESTful
• SoapUI
• SOAtest
• تخفيض السعر

• مواصفات OpenAPI
• مخطط واجهة برمجة التطبيقات
• WADL

• الموقع الرسمي لجمهورية مصر العربية
• مستودعات RAML على GitHub
• إضافة RAML/APIHub لبرنامج SoapUI
• مواصفات وأدوات RAML المفتوحة متاحة الآن للمساعدة في تصميم واجهات برمجة التطبيقات (API). مؤرشفة بتاريخ ٢١ مارس ٢٠١٤ على موقع Wayback Machine.
• مؤسس شركة MuleSoft، روس ماسون، يتحدث عن تجنب كارثة واجهات برمجة التطبيقات (API).
• تُسهّل MuleSoft إدارة واجهات برمجة التطبيقات (APIs).
• إضافة Spring WebService إلى RAML لـ Maven