بررسی اجمالی عیب یابی پورتال توسعه دهندگان مبتنی بر دروپال

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

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

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

نحوه کار اسمارت داکس

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

برای مثال:

آدرس اینترنتی (URL) پروکسی smartdocs به عنوان یک ویژگی قابل تنظیم در مسیر Configuration -> SmartDocs -> SmartDocs proxy URL نمایش داده می‌شود. اگر API شما در یک شبکه خصوصی است و درخواست‌های API زنده با استفاده از SmartDocs از پورتال شما با شکست مواجه می‌شوند، ممکن است لازم باشد این آدرس اینترنتی را تغییر دهید.

نحوه ارتباط پورتال توسعه‌دهندگان با اج

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

برای اطلاعات بیشتر، به بخش ارتباط بین پورتال و Edge مراجعه کنید.