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