درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
Apigee توصیه می‌کند که هنگام ساختن درگاهتان، روال‌های مطلوب شرح‌داده‌شده در بخش‌های زیر را اعمال کنید.
بینندگانتان را جلب کنید
محتوایی اضافه کنید که مخاطبان شما را ازنظر بصری درگیر کند و آن‌ها را ترغیب کند که بیشتر یاد بگیرند. مصرف‌کنندگان API را قادر کنید بخشی از درگاهتان را بدون ورود به سیستم کاوش کنند. ثبت‌نام خودخدمت ارائه دهید تا بتوانند به‌سرعت برای ساختن برنامه‌ها بااستفاده از میاناهای برنامه‌سازی کاربردی شما آماده شوند.
به کاربران اجازه دهید میاناهای برنامه‌سازی کاربردی شما را امتحان کنند
اسناد تعاملی API را به‌طور خودکار از «مشخصات OpenAPI» خودتان تولید کنید تا کاربران بتوانند:
- درباره میانای برنامه‌سازی کاربردی بیشتر بدانید
- ارسال درخواست زنده به API
مشاهده پاسخ زنده‌ای که از API برگردانده شده است
برای اطلاعات بیشتر، به انتشار میاناهای برنامه‌سازی کاربردی مراجعه کنید.
پرداختن به مسیرهای یادگیری اصلی
مثال‌هایی از موارد استفاده و آموزش‌های گام‌به‌گام ارائه دهید که برای مخاطبان شما مرتبط باشد و براساس سطح تجربه آن‌ها باشد. با مثال نشان دهید، مثلاً با یک توالی فرمان ساده curl، یا با گام‌به‌گام پیش رفتن در یک رویه پیچیده‌تر.
پیاده‌سازی بهینه‌سازی موتور جستجو (SEO)
مطمئن شوید محتوای شما قابل جستجو باشد. روی بهینه‌سازی موتور جستجو (SEO) سرمایه‌گذاری کنید تا رتبه شما در نتایج جستجو بهبود یابد و کاربران بتوانند محتوای شما را پیدا کنند.
هنگام ساختاردهی محتوای خود از روال‌های مطلوب زیر استفاده کنید. برای کسب اطلاعات بیشتر و دستورالعمل‌های تکمیلی از Google، به راهنمای آغازگر بهینه‌سازی موتور جستجوی Google مراجعه کنید.
| روال مطلوب | شرح | مزايا |
|---|---|---|
| ایجاد نشانی‌های وب کاربرپسند | نشانی‌های وب قابل‌فهم و قابل‌خواندن برای انسان ایجاد کنید. هنگام افزودن صفحه‌ها به درگاهتان، نشانی وب صفحه کاربرپسندی را تعریف کنید، همان‌طور که در ایجاد صفحه توضیح داده شده است. |
|
| نامی توصیفی برای درگاه ارائه دهید | نامی منحصربه‌فرد و توصیفی برای درگاهتان تعریف کنید، همان‌طور که در مدیریت درگاه‌ها توضیح داده شده است. این محتوا برای پر کردن برچسب <title> برای صفحه اصلی (index) درگاه شما استفاده می‌شود. |
|
| پیمایش سایتتان را آسان کنید | ساختار پیمایشی تعریف کنید که منطقی باشد، همان‌طور که در راه‌اندازی پیمایش توضیح داده شده است. |
|
| از ترکیب خوبی از عبارت‌های کلیدواژه در سراسر محتوا استفاده کنید | وقتی کلیدواژه‌ها مرتبط هستند و منطقی است که آن‌ها را در محتوایتان بگنجانید، این کار را انجام دهید. برجستگی رشته کلیدواژه در صفحه شما می‌تواند رتبه صفحه را در نتایج جستجو بهبود دهد. سعی کنید رشته‌های کلیدواژه‌ای را که کاربران ممکن است هنگام جستجوی محتوای شما استفاده کنند پیش‌بینی کنید. مراقب باشید که کلیدواژه‌انباشی نکنید، یعنی از کلیدواژه‌ها صرفاً با هدف بهبود رتبه جستجو بیش‌ازحد استفاده نکنید. این کار ممکن است باعث شود موتورهای جستجو سایت شما را جریمه کنند. | کاربرانی که به‌دنبال محتوا هستند احتمال بیشتری دارد که نتایج مرتبط دریافت کنند. |
ساختن انجمن توسعه‌دهندگان
از رسانه‌های اجتماعی برای تبلیغ انجمن API خود ازطریق کانال‌های اجتماعی استاندارد مانند فیس‌بوک، توییتر و غیره استفاده کنید. وبلاگ‌ها و انجمن‌هایی منتشر کنید که ارتباط و تعامل بین توسعه‌دهندگان در انجمن API شما را تقویت کنند.