نمای کلی عیب‌یابی «درگاه توسعه‌دهندگان» مبتنی بر Drupal

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید.
اطلاعات

به‌عنوان ارائه‌دهنده API، به روشی نیاز دارید تا APIهای خود را آشکار کنید، توسعه‌دهندگان را درباره APIهای خود آموزش دهید، توسعه‌دهندگان را ثبت‌نام کنید، و به توسعه‌دهندگان اجازه دهید برنامه‌ها را ثبت کنند. ‫Apigee Edge درگاه «خدمات توسعه‌دهندگان» را دراختیارتان قرار می‌دهد که می‌توانید از آن برای ساختن و راه‌اندازی وب‌سایت سفارشی خودتان استفاده کنید تا این خدمات را به انجمن توسعه‌دهندگان خود ارائه دهید. برای کسب اطلاعات بیشتر درباره درگاه‌های توسعه‌دهندگان، به درگاه توسعه‌دهندگان چیست؟ مراجعه کنید.

بخش‌های زیر مفاهیم کلیدی را که باید قبل‌از عیب‌یابی کردن مشکلات در درگاه توسعه‌دهنده خود درک کنید شرح می‌دهد.

نحوه عملکرد SmartDocs

مشخصات OpenAPI (JSON یا YAML) یا WADL که میانای برنامه‌سازی کاربردی شما را توصیف می‌کند می‌تواند به SmartDocs وارد شود و برای انتشار اسناد مرجع میانای برنامه‌سازی کاربردی در درگاهتان استفاده شود. مستندات مرجع API به‌طور خودکار در برگه «میاناهای برنامه‌سازی کاربردی» در درگاه شما ظاهر می‌شود. توسعه‌دهندگان ازطریق درگاه، اسناد میانای برنامه‌سازی کاربردی را کشف می‌کنند و می‌توانند درخواست‌های زنده میانای برنامه‌سازی کاربردی ارسال کنند. ازآنجایی‌که درخواست‌های API از مرورگر منشأ می‌گیرند، برای اینکه این درخواست‌ها موفقیت‌آمیز باشند، باید از CORS (هم‌رسانی منبع میان‌مبدئی) پشتیبانی شود. پشتیبانی از CORS توسط پراکسی «smartdocs» در Edge (در سازمان «VALIDATE») ارائه می‌شود که به‌عنوان پراکسی برای همه درخواست‌های SmartDocs به نقطه پایانی موردنظر عمل می‌کند. کارگزار «smartdocs» زمانی ایجاد می‌شود که SmartDocs را نصب کنید.

برای مثال:

نشانی وب پراکسی smartdocs به‌عنوان یک دارایی پیکربندی‌پذیر در «پیکربندی -> SmartDocs -> نشانی وب پراکسی SmartDocs» نمایان می‌شود. اگر میانای برنامه‌سازی کاربردی شما در شبکه خصوصی باشد و درخواست‌های زنده میانای برنامه‌سازی کاربردی بااستفاده از SmartDocs از درگاهتان ناموفق باشد، ممکن است لازم باشد این نشانی وب را اصلاح کنید.


نحوه ارتباط «درگاه توسعه‌دهندگان» با Edge

درگاه توسعه‌دهنده بیشتر اطلاعاتی را که نمایش می‌دهد، ازجمله Smartdocs، توسعه‌دهندگان، محصولات، و برنامه‌های توسعه‌دهنده، در Edge ذخیره و بازیابی می‌کند. اطلاعات سازمان Edge و اطلاعات اعتباری devadmin بااستفاده از دستور منو «پیکربندی -> Devportal» قابل پیکربندی است.

برای اطلاعات بیشتر، برقراری ارتباط بین درگاه و Edge را ببینید.