أفضل الممارسات لإنشاء بوابة

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

وتقترح Apigee تطبيق أفضل الممارسات الموضحة في الأقسام التالية عند إنشاء البوابة.

التفاعل مع الجمهور

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

السماح للمستخدمين بتجربة واجهات برمجة التطبيقات

يمكنك إنشاء وثائق واجهة برمجة التطبيقات التفاعلية تلقائيًا من خلال مواصفات OpenAPI لتمكين المستخدمين من:

  • مزيد من المعلومات عن واجهة برمجة التطبيقات
  • إرسال طلب مباشر إلى واجهة برمجة التطبيقات
  • الاطّلاع على ردّ مباشر من واجهة برمجة التطبيقات

    لمزيد من المعلومات، يُرجى الاطّلاع على نشر واجهات برمجة التطبيقات.

معالجة المسارات التعليمية الأساسية

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

تطبيق عملية تحسين محركات البحث (SEO)

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

تحسين محركات البحث

اتّبِع أفضل الممارسات التالية عند تنظيم المحتوى. للحصول على المزيد من المعلومات والإرشادات الإضافية من Google، راجِع دليل بدء تحسين محرّكات البحث من Google.

أفضل الممارسات الوصف المزايا
إنشاء عناوين URL سهلة الاستخدام أنشئ عناوين URL يسهُل فهمها ويمكن للمستخدمين قراءتها. حدِّد عنوان URL لصفحة سهل الاستخدام عند إضافة صفحات إلى البوابة، كما هو موضّح في إنشاء صفحة.
  • تنقل الغرض من الصفحة في نموذج يمكن لشخص عادي قراءته.
  • تؤدي المطابقة الكاملة أو الجزئية للكلمات الرئيسية في عنوان URL للصفحة إلى تحسين ترتيب البحث.
  • عادةً ما تظهر عناوين URL في نتائج البحث.
توفير اسم وصفي للبوابة حدِّد اسم بوابة وصفي وفريدًا، على النحو الموضّح في قسم إدارة بوابات الويب. يتم استخدام هذا المحتوى لتعبئة علامة <title> للصفحة الرئيسية (index) على المنصة.
  • تؤدي المطابقة الكاملة أو الجزئية للكلمات الرئيسية في العنوان إلى تحسين ترتيب البحث.
  • عادةً ما يتم عرض محتوى عناوين صفحاتك كسطر أول من نتائج البحث.
تسهيل التنقّل في موقعك الإلكتروني حدد بنية تنقل منطقية، كما هو موضح في إعداد التنقل.
  • يُبقي المستخدمين موجهين.
  • يساعد المستخدمين في العثور على المحتوى الذي يريدونه بسرعة وسهولة.
استخدام مزيج جيد من العبارات المستخدَمة ككلمة رئيسية في مختلف أجزاء المحتوى ضمِّن كلمات رئيسية في المحتوى عندما يكون ذا صلة ومنطقيًا في ذلك. يمكن أن يؤدي ظهور سلسلة الكلمة الرئيسية على صفحتك إلى تحسين ترتيب الصفحات في نتائج البحث. حاوِل توقُّع سلاسل الكلمات الرئيسية التي قد يستخدمها المستخدمون عند البحث عن المحتوى الذي تقدّمه. يجب توخّي الحذر من ازدحام الكلمات الرئيسية، أي الإفراط في استخدام الكلمات الرئيسية لغرض وحيد وهو تحسين ترتيب نتائج البحث. قد يؤدي ذلك إلى فرض عقوبات على موقعك الإلكتروني من قِبل محرّكات البحث. تزيد احتمالية حصول المستخدمين الذين يبحثون عن محتوى على نتائج ملائمة.

بناء منتدى للمطوّرين

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