أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
يمكنك إنشاء مواصفات 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. أثناء الكتابة، إذا كانت هناك أخطاء في مواصفات OpenAPI، يعرض محرِّر المواصفات مربّع حوار الخطأ في أعلى اللوحة اليمنى ويقدّم المزيد من المعلومات عن الأخطاء وأرقام الأسطر المرتبطة بها حتى تتمكّن من تصحيحها بسهولة.
حفظ مواصفة
لحفظ مواصفات OpenAPI، انقر على حفظ في شريط التنقّل العلوي.
إذا كانت هذه هي المرة الأولى التي تحفظ فيها المواصفة، سيُطلب منك إدخال اسم ملف. إذا لم تحدِّد اسم ملف، سيتم ضبطه تلقائيًا على "بلا عنوان". ويمكنك إعادة تسميته لاحقًا.
إغلاق مواصفة
لإغلاق مواصفة OpenAPI بدون حفظ التعديلات، انقر على إلغاء في شريط التنقّل العلوي. ستتم إعادتك إلى قائمة المواصفات.