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