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

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

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

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

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

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

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

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

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

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

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

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

تنفيذ تحسين محركات البحث (SEO)

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

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

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

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

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