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