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