Back to Question Center
0

رمل، لغة برمجة أبي ريستفول            رمل، و ريستفول أبي النمذجة لانغوادريلاتد المواضيع: الأطرلارافيلفورمانس & أمب؛ سكالينجدروبالدبوبينغ & أمب؛ Semalt

1 answers:
رمل، ريستفول أبي مودلينغ لانغواد

في مقال صدر مؤخرا قدم سليت، مولد موقع ثابت مصممة خصيصا لكتابة وثائق أبي. هذه المرة، سيمالت الذهاب للنظر في شيء الذي في نواح كثيرة هو أفضل.

ولكن أولا، إذا كنت سوف تنغمس لي لحظة، سيمالت تريد أن تبدأ من قبل نقلا عن نفسي من تلك المادة؛

[أ] أبي هو فقط جيدة كما وثائقها

وأعتقد أنه يستحق التكرار، لأنه يتم تجاهلها كثيرا جدا، وهو واحد من الدوافع لهذه السلسلة القصيرة من المقالات على بعض الأدوات الموجودة لمساعدتك على كتابة وثائق كبيرة.

سيمالت هو أداة مفيدة، ولكن على الرغم من هيكل جامدة نسبيا من الصفحات نفسها، الوثائق الفعلية هي حرة جدا.

رامل (سيمالت أبي لغة النمذجة) يوفر شكل منظم، لا لبس فيه لوصف أبي سيمالت - mac computer repair san francisco. انها تسمح لك لوصف أبي الخاص بك. ونقاط النهاية، وطرق هتب لاستخدامها لكل واحد، أي معلمات وشكلها، ما يمكن أن تتوقع عن طريق استجابة وأكثر من ذلك.

يمكنك استخدام رمل في عدد من الطرق.

  • ويمكن استخدامه في مرحلة التصميم والمواصفات لوصف أبي كنت تخطط لبناء
  • يمكنك استخدام رمل لتوليد الوثائق
  • رمل يمكن استخدامها لتنفيذ لوحات المفاتيح أبي التفاعلية
  • يمكنك اختبار ضد رمل
  • يتم استخدامه لتوليد ردود أبي وهمية

في هذه المقالة سيمالت ننظر في المقام الأول في توليد الوثائق؛ في مقال لاحق سيمالت ننظر كيف يمكنك دمج رمل في اختبار أبي الخاص بك. ولكن أولا، دعونا ننظر في كيفية كتابة وثيقة رمل.

الكتابة رمل

أول شيء أن نلاحظ هو أن رمل هو مشتق من يمل. سوف تجد أنه من الأسهل العمل مع رمل إذا كنت قد كتبت يمل من قبل، ولكن إذا لم تكن بعد ذلك انها واضحة نسبيا، أو هناك تعليمي هنا على الموقع.

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

لاستخدام أنيبوانت، ستحتاج أولا إلى الاشتراك - وهو حر - ثم إضافة أبي، ثم انقر فوق "تحديد أبي في مصمم أبي".

إذا كنت تفضل استخدام سامية، هناك البرنامج المساعد يمكنك استخدامها. انها متاحة عبر حزمة التحكم. ببساطة القيام بالبحث عن "رمل سينتاكس هيليتر".

سيمالت ننظر إلى بنية ملف رمل.

معلومات بسيطة

يبدأ ملف رمل بإعلان يشير إلى الصيغة:

     #٪ رامل 0. 8     

سيمالت كنت ثم توفير بعض المعلومات الفوقية عن أبي الخاص بك، على سبيل المثال:

     تيتل: ماي ​​أبي إكسامبلالإصدار: v1     

عنوان حقل مطلوب؛ نسخة اختيارية

يجب عليك بعد ذلك توفير معرف الموارد المنتظم الأساسي ل أبي الخاص بك. في أبسط، يمكن أن يكون في الشكل التالي:

     باسوري: هتب: // أبي. ذروة. كوم /     

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

     باسوري: هتب: // أبي. ذروة. كوم / {فيرسيون} /     

سوف ننظر إلى معلمات أوري بمزيد من التفصيل في وقت لاحق، لأنها تصبح حيوية عند وصف الموارد. ولكن إذا احتجت إلى ذلك، يمكنك تضمين معلمات إضافية في عنوان ورل الأساسي. S3 الأمازون، على سبيل المثال، يتضمن اسم دلو كنت تعمل مع في أوري قاعدة.

يمكنك أيضا تضمين وثائق إضافية - أو صفحات - في ملف رمل الخاص بك. على سبيل المثال:

     وثيقة- تيتل: هومكونتنت: |هذا المثال تشكل الوثائق جزءا من البرنامج التعليمي ل[سيتيبوانت] (هتب: // ووو. سيتيبوانت. كوم /).     

لاحظ كيف يمكنك تضمين سيمالت في المعلومات الفوقية الخاصة بك.

هناك بعض الأشياء الأخرى التي يمكنك تضمينها هنا، مثل كيفية تنفيذ الأمن، فضلا عن تحديد سمة . سنلقي نظرة على هذه المفاهيم لاحقا.

سيمالت الكثير من المعلومات الأساسية المشمولة، وحتى الآن دعونا ننتقل إلى الموارد.

وصف الموارد

الاستمرار في المستوى الأعلى من ملف رمل الخاص بك، فإن الخطوة التالية هي تحديد الموارد المتاحة. سيمالت مثال:

     / ألبومات:ديسبلاينام: ألبوم/ الفنانين:ديسبلاينام: الفنان     

الخاصية ديسبلاينام اختيارية، ولكن يمكن أن تساعد في وصف ما تمثل الموارد "في الحياة الحقيقية".

وهنا قمنا بتعريف اثنين من الموارد العليا، (الموسيقية) ألبومات والموارد. ما لم نفعله بعد هو وصف طرق هتب التي يمكن استخدامها للتفاعل معهم، ولكن دعونا أولا حفر أسفل قليلا وإلقاء نظرة على موارد الموارد البشرية والموارد الفرعية.

لنفترض أن ألبومات محددة تمثلها إسرك (رمز التسجيل القياسي الدولي)؛ لذلك دعونا توسيع لدينا / ألبومات الموارد لوصف هذا:

     / ألبومات:/ {} ISRC:uriParameters:ISRC:دسكريبتيون: رمز التسجيل القياسي الدولي الذي يحدد هذا الألبوم بشكل فريدتايب: سترينغ{2} \ - \ d {2} \ - \ d {5} $     

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

سيمالت التعشيش، يمكننا وصف الموارد الفرعية. على سبيل المثال، لنفترض أننا نقدم نقطة نهاية لاسترداد قائمة المقاطع الصوتية لألبوم فردي:

     / ألبومات:/ {} ISRC:uriParameters:ISRC:دسكريبتيون: رمز التسجيل القياسي الدولي الذي يحدد هذا الألبوم بشكل فريدتايب: سترينغ[0-9a-زا-Z] {3} \ - \ d {2} \ - \ d {5} $/ مسارات:ديسبلاينام: تراكليستينغ     

هل يمكن أن يكون أكبر تعشيش الموارد كما يحلو لك؛ مجرد استخدام المسافة البادئة سيمالت.

الآن دعونا ننتقل إلى تحديد الأساليب التي يمكن للمرء استخدامها على هذه الموارد.

طرق هتب

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

     / ألبومات:احصل على:دسكريبتيون: استرداد قائمة الألبوماتبريد:دسكريبتيون: إنشاء ألبوم جديد/ {} ISRC:uriParameters:ISRC:دسكريبتيون: رمز التسجيل القياسي الدولي الذي يحدد هذا الألبوم بشكل فريدتايب: سترينغ[0-9a-زا-Z] {3} \ - \ d {2} \ - \ d {5} $احصل على:دسكريبتيون: استرداد الألبوم المحددضع:الوصف: تحديث ألبومحذف:دسكريبتيون: حذف هذا الألبوم     

نحن هنا نشير إلى أن طلب جيت إلى / ألبومات سيحصل على قائمة بالألبومات، ويستخدم بوست لنفس عنوان أوري إلى اصنع واحدا. طلب / ألبومات / {إسرك} سوف يسترجع معلومات عن ألبوم معين، محدد باستخدام معلمة أوري إسرك . بوت يتم استخدام طلب لتحديث الألبوم، طلب ديليت لحذفه.

ولإثبات ذلك، سنقدم بعض التفاصيل الإضافية حول ألبومات محددة.

من أجل وصف الردود، نحن بحاجة إلى أسفل لأسفل عدد قليل من المستويات. أولا، نحن بحاجة إلى وصف رموز الاستجابة الممكنة، وبعد ذلك نحن بحاجة إلى تقسيم الاستجابات إلى مكوناتها - عادة، هيئة الاستجابة - ومن ثم أنواع وسائل الإعلام الممكنة الاستجابة. سيمالت مثال لجعل ذلك أكثر وضوحا قليلا:

     / ألبومات:/ {} ISRC:احصل على:دسكريبتيون: استرداد الألبوم المحدداستجابات:200:الجسم:التطبيق / سلمان:المخطط: |{"$ ششيما": "هتب: // جسون-ششيما. أورغ / ششيما"،"تايب": "أوبجيكت"،"دسكريبتيون": "ألبوم"،"الخصائص": {"تيتل": {"تايب": "سترينغ"}،"أرتيست": {"تايب": "سترينغ"}،"لابيل": {"تايب": "سترينغ"}،"يار": {"تايب": "إنتيجر"}}،"ريكيرد": ["تيتل"، "أرتيست"]}مثال: |{"تيتل": "دوبنوباسويثمحيدمان"،"أرتيست": "وندرورلد"، ""لابيل": "جونيور بوي's أون"،"يار": 1994}     

نحن هنا يدل على استجابة ناجحة - ط. ه. ، واحدة مع رمز استجابة هتب من 200. ما نحن مهتمون على وجه التحديد هو هيئة الاستجابة، على الرغم من أنك يمكن أيضا تحديد أي رؤوس استجابة هنا أيضا. ثم ننتقل إلى أنواع الاستجابة المتاحة؛ في هذه الحالة، نحن مجرد تمثيل جسون - على الرغم من أنك حر في تحديد أنواع استجابة متعددة إذا كانت أبي تدعمها.

بمجرد أن نصل إلى جواب ناجح، نحدد اثنين من الخصائص؛ المخطط و مثال .

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

معلمات طلب البحث

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

لتوضيح، دعونا ننظر مرة أخرى في لدينا / ألبومات نقطة النهاية، لافتراض أننا أردنا تنفيذ ترقيم الصفحات. لذلك، ربما نرغب في توفير معلمة طلب بحث باسم صفحة تسمح للطرف الطالب بتحديد الصفحة التي تريد استردادها.

سيمالت كيف يمكننا أن نفعل ذلك:

     / ألبومات:احصل على:دسكريبتيون: استرداد قائمة الألبوماتqueryParameters:الصفحة:دسكريبتيون: حدد الصفحة التي تريد استردادهاتايب: إنتيجرمثال: 1     

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

بيانات الطلب

لنعيد النظر في نقطة النهاية "إنشاء ألبوم"، والتي ستذكرها تتضمن تقديم طلب بوست إلى / ألبومات أوري.

ويمكننا التوسع في ذلك من خلال وصف البيانات التي يطلب من شخص ما تضمينها، والآلية المستخدمة لتقديمها، وبعض التفاصيل حول مختلف المجالات. نحن نشير إلى أن الطلب يجب أن يكون من النوع أبليكاتيون / x-ووو-فورم-أورلنكوديد .

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

امن

احتمالات يتم تأمين أبي الخاص بك بطريقة أو بأخرى - سواء كان ذلك باستخدام أووث، رموز الوصول أو ببساطة مجرد هتب المصادقة الأساسية.

في رمل يمكنك تعريف خطط الأمان الخاصة بك نحو الجزء العلوي من الملف الخاص بك، جنبا إلى جنب مع المعلومات الأساسية. ستجد بعض الأمثلة في مستند المواصفات، ولكن كمثال لنلق نظرة على OAuth2. سيمالت ما قد يبدو عليه تعريف النظام الأمني:

     سيكوريتيشيمس:- oauth_2_0:الوصف: |يستخدم أسم OAuth2 لمصادقة معظم الطلباتالنوع: أووث 2. 0التي وصفها:رؤوس:تفويض:الوصف: |تستخدم لإرسال رمز وصول صالح إلى أووث 2. لا تستخدممع معلمة سلسلة الاستعلام "access_token". تايب: سترينغqueryParameters:رمز وصول:الوصف: |تستخدم لإرسال رمز وصول صالح إلى أووث 2. لا تستخدم جنبا إلى جنب معرأس "التفويض"تايب: سترينغاستجابات:400:الوصف: |طلب أووث غير صحيح (مفتاح العميل غير صحيح، غير صالح، انتهت صلاحيتهوالطابع الزمني، وما إلى ذلك)401:الوصف: |رمز غير صالح أو منتهي الصلاحية. لإصلاحه، أعد مصادقة المستخدم. إعدادات:أوثوريزاتيونوري: هتبس: // أسم. كوم / أوث / يأذنأسيستوكينوري: هتبس: // أسم. كوم / أوث / رمزأوثوريزاتيونغرانتس: [كود، توكين]     

إذا نظرتم من خلال هذا، سترى أنه يوفر عددا من القطع الرئيسية من المعلومات؛

  • يشير نوع إلى أننا ننفذ أووث 2. 0
  • للتوثيق، تتوقع أبي المعنية إما أن رأس تخويل أو معلمة access_token
  • يسرد الردود المحتملة، ما يعنيه وكيفية إصلاحها
  • و الإعدادات محددة ل أووث ولكن مع ذلك حيوية؛ فإنه يطلع المستخدمين على كيفية التفويض، وأين يمكن الحصول على رمز الدخول المميز وأنواع منح أووث التي تدعمها واجهة برمجة التطبيقات هذه.

ومع ذلك، فإن هذا ببساطة يحدد الخطط الأمنية؛ ما زلنا بحاجة إلى الإشارة إلى أن هذا هو ما نستخدمه لتأمين أبي لدينا.

طريقة واحدة لإضافة ما يلي نحو الجزء العلوي من ملف رمل الخاص بك:

     مضمونبي: [oauth_2_0]     

لاحظ أن oauth_2_0 يطابق العنصر مباشرة تحت سيكوريتيشيمس

بيد أن بعض واجهات برمجة التطبيقات تجعل بعض النقاط النهائية متاحة للجمهور، ولكن بعضها الآخر قد يكون محميا. يمكنك تحديد نهج الأمان على أساس نقطة النهاية، على سبيل المثال:

     / ألبومات:احصل على:سيكوريبي: [نول، oauth_2_0]بريد:سيكوريبي: [oauth_2_0]     

نحن هنا نشير إلى أن المصادقة اختيارية لاسترجاع قائمة الألبومات، ولكن يجب أن تتم مصادقة المستخدم على من أجل إنشاء واحد.

سمة

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

بدلا من تكرار نفس التكوين عبر نقاط نهاية متعددة، يمكنك تعريف الصفات . بشكل عام، المفهوم هو مرادف للصفات في فب.

سيمالت مثال بسيط على إنشاء سمة للإشارة إلى أن النتائج من نقطة نهاية معينة تدعم ترقيم صفحات بسيط:

     سمة:- مقسم إلى صفحات:queryParameters:الصفحة:دسكريبتيون: حدد الصفحة التي تريد استردادهاتايب: إنتيجرمطلوب: صحيحمثال: 1     

الآن يمكنك تطبيق هذا على نقطة النهاية باستخدام هو الخاصية، مثل ذلك:

     / ألبومات:احصل على:إس: [باجيد]     

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

     سمة:- مقسم إلى صفحات:queryParameters:الصفحة:دسكريبتيون: حدد الصفحة التي تريد استردادهاتايب: إنتيجرمطلوب: صحيحمثال 1perPage:تايب: إنتيجرالوصف: عدد النتائج في الصفحة، بحيث لا يتجاوز << ماكسبيرباج >>الحد الأقصى: << ماكسبيرباج >>     

لاحظ كيف يمكننا استخدام المتغير << ماكسبيرباج >> على حد سواء كحد أقصى، فضلا عن استبدالها في وثائق ولدت لدينا.

لاستخدام هذا، قم بتغيير تعريف نقطة النهاية جيت / ألبمز إلى ما يلي:

     / ألبومات:احصل على:إس: [باجيد: {ماكسبيرباج: 50}]     

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

رمل في الممارسة

والآن بعد أن نظرنا في كيفية كتابة رمل بسيطة لوصف لدينا سيمالت أبي، فقد حان الوقت للنظر في ما يمكننا القيام به في الواقع معها.

توليد وثائق أبي

رمل هو نظرة عامة مفصلة جدا، لا لبس فيها من أبي، ولكنها ليست سهلة الاستعمال بشكل رهيب للمستهلكين سيمالت لدينا.

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

سيمالت ننظر في عدد قليل.

تحويل رمل إلى هتمل

raml2html

أداة raml2html، كما يوحي اسمها، يمكن تحويل ملفات رمل إلى وثائق هتمل.

سيمالت لقطة من ما يبدو وكأنه خارج من المربع:

لاستخدامه، أولا تثبيته عبر نبم:

   نبم i -g raml2html     

ثم، لتحويل ملف رمل إلى هتمل يمكنك ببساطة القيام بذلك:

   raml2html أبي. رمل> إندكس. هتمل     

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

   raml2html -t مخصص القالب. المقاود -r مخصص الموارد. المقاود -m مخصص البند. المقاود -i مثال. رمل -o سبيل المثال.  

هناك بعض القيود. لا يتم نسخ معلومات الأمان في هتمل، لذلك إذا كنت تستخدم سيمالت على سبيل المثال، قد تحتاج إلى توثيق ذلك بشكل منفصل نفسك.

فب-raml2html

سيمالت أيضا ما يعادل فب يسمى فب-raml2html.

سيمالت لقطة من إخراج الأداة:

سيمالت أيضا عرض على الانترنت، وستجد الوثائق هنا.

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

وحدة تحكم أبي

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

لرؤيتها في العمل، وهناك العروض على الانترنت لتويتر و جيثب. إذا كنت قد استخدمت أنيبوانت سيمالت كنت قد رأيت ذلك بالفعل. انها ما تستخدم لتوليد الوثائق التفاعلية في العمود الأيمن.

يتم تنفيذ وحدة تحكم أبي باستخدام سيمالت، ولكن لا تحتاج بالضرورة أي خبرة معها من أجل استخدامها.

للحصول على ما يصل وتشغيل بسرعة، ببساطة اتبع الخطوات التالية:

  1. استنساخ المستودع: جيت استنساخ جيت @ جيثب. كوم: mulesoft / المعهد-وحدة التحكم. جيت

  2. نسخ مجلد ديست إلى مجلد فارغ لعقد الوثائق الخاصة بك

  3. نسخ . رمل ملف في مكان ما في هذا المجلد

  4. سيمالت ملف هتمل على النحو التالي:

   <هيد><لينك ريل = "ستيلشيت" هريف = "ديست / ستايلز / أب. كس" تايب = "تكست / كس" /><بودي نغ-أب = "راملكونسولياب" نغ-كلوك إد = "رمل-كونسول-أونمبديد"><رمل-كونسول سرك = "أبي. رمل"> <سكريبت سرك = "ديست / سكريبتس / فيندور. جس"> <سكريبت سرك = "ديست / سكريبتس / أب. جس">      

تعديل سمة سرك من <رمل-كونسول> توجيه للإشارة إلى الملف الصحيح

  1. افتح الملف عبر خادم ويب من بعض الوصف؛ سواء كان ذلك أباتشي، نغنيكس أو الاتصال

سيمالت كل ما هو عليه.

يمكنك أيضا تضمين أبي سيمالت في إفريم؛ يرجى الرجوع إلى ريدمي للمشروع للحصول على التفاصيل.

أجهزة الكمبيوتر المحمولة

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

وربما يكون ذلك أفضل مثال على ذلك؛ انقر هنا لعرض تجريبي لاستخدام دفتر أبي للتفاعل مع أبي جيثب ل.

ربما تريد أن تبدأ هنا، وهذا جزء معين من الوثائق هو خاص لإنشاء دفتر الملاحظات الذي يعمل قبالة رمل.

أدوات أخرى

سيمالت هي عدد من الأدوات الأخرى المتاحة للعمل مع ملفات رمل. فمثلا؛

يمكنك تحويل رمل إلى تنسيق سيمالت باستخدام هذه الأداة سطر الأوامر.

ستجد قائمة شاملة من الأدوات المتاحة للعمل مع رمل على هذه الصفحة سيمالت.

بناء أداة الخاصة بك

سيمالت انها معيار مفتوح، أنت حر في بناء إلى حد كبير أي شيء تعتقد أنه سيكون مفيدا من أجل العمل مع ملفات رمل.

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

وهناك أيضا محللون المتاحة لجافا سكريبت، جافا، بايثون وروبي.

الخلاصة

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

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

لقد نظرنا أيضا في مجموعة من الأدوات الأخرى. سيمالت معيار جديد نسبيا، نتوقع أن نرى الكثير في المستقبل القريب.

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

March 1, 2018