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