Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi
Apigee X. info
Sebagai penyedia API, Anda memerlukan cara untuk mengekspos API, mengedukasi developer tentang API, mendaftarkan developer, dan mengizinkan developer mendaftarkan aplikasi. Apigee Edge menyediakan portal Layanan Developer yang dapat Anda gunakan untuk membuat dan meluncurkan situs kustom Anda sendiri guna menyediakan layanan ini kepada komunitas pengembangan Anda. Untuk mempelajari portal developer lebih lanjut, lihat Apa yang dimaksud dengan portal developer?
Bagian berikut menjelaskan konsep utama yang harus Anda pahami sebelum memecahkan masalah pada portal developer.
Cara kerja SmartDocs
Spesifikasi OpenAPI (JSON atau YAML) atau WADL yang menjelaskan API Anda dapat diimpor ke SmartDocs dan digunakan untuk memublikasikan dokumentasi referensi API ke portal Anda. Dokumentasi referensi API akan muncul di tab API di portal Anda secara otomatis. Developer menemukan dokumentasi API melalui portal dan dapat membuat permintaan API langsung. Karena permintaan API berasal dari browser, dukungan CORS (Cross-Origin Resource Sharing) diperlukan agar permintaan tersebut berhasil. Dukungan CORS disediakan oleh proxy "smartdocs" di Edge (di organisasi "VALIDATE") yang bertindak sebagai proxy untuk semua permintaan SmartDocs ke endpoint yang diinginkan. Proxy "smartdocs" dibuat saat Anda menginstal SmartDocs.
Contoh:
URL proxy smartdocs ditampilkan sebagai properti yang dapat dikonfigurasi di Konfigurasi -> SmartDocs -> URL proxy SmartDocs. Anda mungkin perlu mengubah URL ini jika API Anda berada di jaringan pribadi dan permintaan API aktif yang menggunakan SmartDocs dari portal Anda gagal.
Cara Developer Portal Berkomunikasi dengan Edge
Portal developer menyimpan dan mengambil sebagian besar informasi yang ditampilkan dari Edge, termasuk Smartdocs, developer, produk, dan aplikasi developer. Informasi organisasi Edge dan kredensial devadmin dapat dikonfigurasi menggunakan perintah menu Konfigurasi -> Devportal.
Untuk informasi selengkapnya, lihat Berkomunikasi antara portal dan Edge.