أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
يمكنك إنشاء مواصفات OpenAPI والتحقّق من صحتها بدون كتابة أي رمز برمجي باستخدام أداة تعديل المواصفات.
الوصول إلى محرِّر المواصفات
افتح مواصفات OpenAPI في أداة تعديل المواصفات، كما هو موضَّح في الأقسام التالية:
يعرض الشكل التالي مواصفات Petstore API المفتوحة في محرِّر المواصفات:
كما هو موضّح في الشكل السابق، يتيح لك محرّر المواصفات إجراء ما يلي:
- أنشئ مواصفات OpenAPI لنمذجة واجهة برمجة التطبيقات باستخدام تنسيق JSON أو YAML في اللوحة اليمنى.
- اطّلِع على مستندات واجهة برمجة التطبيقات التي تم إنشاؤها تلقائيًا في اللوحة اليمنى.
- التحقّق من صحة المواصفات مقارنةً بمعيار مواصفات OpenAPI أثناء الكتابة
- احفظ مواصفات OpenAPI أو أغلِق المواصفات وألغِ التعديلات.
ساعدني في JSON وYAML
JSON (كائن JavaScript Notation) هو تنسيق خفيف لتبادل البيانات يُستخدم لتمثيل بنى البيانات البسيطة والمصفوفات الترابطية. لمزيد من المعلومات، انتقِل إلى https://www.json.org.
YAML (YAML Ain't Markup Language) هو معيار تسلسل البيانات/تمثيلها يوفّر بنية يمكن ربطها ببنى البيانات، مثل القوائم والمصفوفات الترابطية والكميات القياسية. لمزيد من المعلومات، يُرجى الانتقال إلى https://yaml.org.
يمكن قراءة كل من JSON وYAML آليًا، كما يسهل على المستخدمين قراءتهما وفهم محتواهما. يقارن الشكل التالي بين مقتطفَين قصيرَين من مواصفات OpenAPI نفسها مكتوبَين باستخدام JSON وYAML:
التحقّق من صحة مواصفات
يتحقّق محرّر المواصفات من صحة مواصفات OpenAPI وفقًا لمعيار مواصفات OpenAPI. أثناء الكتابة، إذا كانت هناك أخطاء في مواصفات OpenAPI، يعرض محرر المواصفات مربّع الحوار "خطأ" في أعلى اللوحة اليمنى ويقدّم المزيد من المعلومات حول الأخطاء وأرقام الأسطر المرتبطة بها حتى تتمكّن من تصحيحها بسهولة.
حفظ مواصفات
لحفظ مواصفات OpenAPI، انقر على حفظ في شريط التنقّل العلوي.
إذا كانت هذه هي المرة الأولى التي تحفظ فيها المواصفات، سيُطلب منك إدخال اسم ملف. إذا لم تحدّد اسم ملف، سيتم ضبط الاسم التلقائي على "بلا عنوان". يمكنك إعادة تسميته لاحقًا.
إغلاق مواصفات
لإغلاق مواصفات OpenAPI بدون حفظ تعديلاتك، انقر على إلغاء في شريط التنقل العلوي. ستتم إعادتك إلى قائمة المواصفات.