Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Contoh API Apigee Edge berisi contoh proxy API, kebijakan, kode, dan alat yang menggambarkan kemampuan Layanan API Apigee Edge yang dijelaskan di bawah.
Untuk petunjuk penggunaan contoh, lihat Menggunakan proxy API contoh.
Belajar dengan melakukan praktik
Ingin segera mempraktikkan dan mulai membangun basis pengetahuan yang solid tentang Apigee Edge? Kami memiliki library contoh "learn-edge" di GitHub yang memungkinkan Anda men-deploy, memanggil, dan melacak beberapa proxy contoh dengan cepat, dimulai dengan proxy yang paling sederhana dan beralih ke proxy yang menggambarkan validasi kunci API, kuota, penyiapan respons, penanganan kesalahan, dan lainnya.
Setelah meng-clone repo dan menyiapkan lingkungan (hanya perlu beberapa menit), Anda dapat mencoba setiap contoh dalam kurang dari satu menit. Selain itu, karena setiap sampel membuat revisi baru dari proxy yang sama, lingkungan Anda tidak akan dipenuhi dengan banyak sampel. Anda dapat mengganti revisi, men-deploy ulang revisi yang berbeda di UI pengelolaan, dan melihat kode proxy kapan saja. File readme untuk setiap contoh juga memberikan ringkasan singkat tentang fungsi contoh dan cara penyiapannya.
Coba sekarang! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Contoh cookbook dokumen
Kumpulan sampel disediakan untuk topik buku resep proxy API.
| Nama | Deskripsi | Jenis Kebijakan | Resource |
|---|---|---|---|
| javascript-cookbook | Menunjukkan cuplikan JavaScript sederhana yang menambahkan header HTTP dari variabel, mengubah laporan cuaca berformat XML dari JSON ke XML, dan memangkas konten untuk klien seluler. | minimize.js setHeaders.js |
|
| javascript-mashup-cookbook | Aplikasi JavaScript lengkap yang memanggil API publik, menggabungkan hasil, dan membuat respons yang lebih baik untuk aplikasi klien. (Catatan: proxy API ini menerapkan fungsi yang sama dengan mashup kebijakan, yang menunjukkan bahwa masalah yang sama dapat diatasi menggunakan teknik yang berbeda.) | Javascript | MashItUp.js |
| java-hello | Panggilan Java hello world sederhana. | JavaCallout | JavaHello.java |
| java-cookbook | Mengonversi konten dan header respons menjadi huruf besar. | JavaCallout |
ResponseUppercase.java |
| java-properties | Menunjukkan cara menggunakan properti dalam panggilan Java. | JavaCallout | JavaProperties.java |
| java-error | Menunjukkan pola penanganan error yang dapat Anda gunakan dalam kode Panggilan Java. | JavaCallout | JavaError.java |
| policy-mashup-cookbook | Aplikasi lengkap yang menggunakan komposisi kebijakan untuk memanggil dua API publik, menggabungkan hasil, dan menghasilkan respons yang lebih baik untuk aplikasi klien. (Catatan: proxy API ini menerapkan fungsi yang sama dengan javascript-mashup, yang menunjukkan bahwa masalah yang sama dapat diatasi menggunakan teknik yang berbeda.) | AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON |
GenerateResponse.js |
Contoh proxy API
Proxy API berikut berada di GitHub, tempat halaman readme memberikan deskripsi mendetail tentang contoh. Jika Anda tertarik dengan cara kerja kebijakan tertentu dalam sampel, cari di kolom Jenis Kebijakan di bawah untuk menemukan kebijakan yang Anda minati, lalu klik nama sampel di kolom Nama. (Kebijakan ditautkan ke halaman referensinya masing-masing dalam dokumen.)
Referensi dan Alat
Selain contoh cookbook dokumen dan proxy contoh dalam tabel di atas, contoh GitHub Edge juga berisi referensi berikut:
| Nama | Deskripsi | Jenis Kebijakan | Resource |
|---|---|---|---|
| regex-protection | Kebijakan perlindungan terhadap ancaman ekspresi reguler dapat melindungi API backend dan mikroservice Anda dari serangan injeksi SQL. | T/A | |
| oauth-validate-key-secret | Anda menerapkan alur jenis pemberian Sandi OAuth. Anda harus memvalidasi kunci dan rahasia klien aplikasi di Edge sebelum memanggil Penyedia Identitas eksternal untuk memvalidasi kredensial pengguna. | OAuthV2, lainnya | T/A |
| condition-pattern-matching | Proxy ini memudahkan Anda mencoba dan menguji pernyataan bersyarat dalam alur proxy API. | AssignMessage | T/A |
| access-entity | Menunjukkan cara mengambil profil untuk entity dari datastore Apigee Edge. | AssignMessage AccessEntity ExtractVariables |
tidak ada |
| apikey | Menerapkan validasi kunci API sederhana | VerifyAPIKey AssignMessage Quota |
tidak ada |
| async-callout | Menunjukkan panggilan asinkron sederhana menggunakan httpClient JavaScript. | Javascript | assemble_response.js callout.js |
| base64encoder | Menunjukkan cara memanggil include JavaScript dari resource JavaScript di proxy API. | AssignMessage Javascript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| conditional-policy | Menerapkan penegakan kebijakan bersyarat sederhana. Jika permintaan berisi header HTTP responsetime:true, kebijakan akan menjalankan skrip Python yang menambahkan serangkaian metrik performa ke pesan respons, sebagai header HTTP | Skrip (Python) | timer.py |
| dynamic-endpoint | Menerapkan pemilihan rute bersyarat sederhana dalam skenario yang sedikit lebih kompleks, yang menentukan dua URL dan satu rute default. | tidak ada | tidak ada |
| jira-release-notes | Ini adalah proxy API yang digunakan oleh tim dokumentasi Apigee untuk membuat catatan rilis dari Jira. | JSONToXML XSL |
releasenotes_api.xsl |
| kerberos-credential-mediation | Contoh ini menunjukkan cara melakukan Mediasi Kredensial Kerberos di Apigee Edge. | JavaCallout | File JAR Java |
| oauth-advanced | Contoh lengkap dan berfungsi dari alur jenis pemberian kode otorisasi, dengan Apigee Edge sebagai server otorisasi. |
GenerateAccessToken Banyak lainnya... |
lihat contoh kode |
| oauth-client-credentials | Menunjukkan endpoint token OAuth 2.0 yang berfungsi penuh dan dikonfigurasi untuk jenis pemberian kredensial klien. | GenerateAccessToken | tidak ada |
| oauth-login-app | Tidak digunakan lagi. Sebaiknya lihat contoh oauth-advanced. | ||
| oauth-validate-key-secret | Mengilustrasikan teknik untuk memvalidasi kunci dan secret klien sebelum memanggil penyedia identitas untuk memvalidasi kredensial pengguna dalam alur jenis pemberian sandi. | OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault |
tidak ada |
| oauth-verify-accesstoken | Menunjukkan proxy API yang dikonfigurasi untuk memvalidasi token akses OAuth 2.0 dan memverifikasi Kuota. | VerifyAccessToken Quota |
tidak ada |
| oauth10a-3legged | Menunjukkan konfigurasi three-legged OAuth 1.0a. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
tidak ada |
| outbound-oauth | Menggunakan Microsoft Azure Translator API untuk menerjemahkan tweet. Untuk melakukannya, proxy API melakukan panggilan keluar untuk mendapatkan token akses OAuth, lalu menyimpan token ke dalam cache menggunakan kebijakan caching API Services, dengan menggunakan kembali token yang di-cache setiap kali panggilan keluar dilakukan. Selain itu, menyertakan aplikasi browser demonstrasi yang digunakan untuk memanggil proxy API. | AssignMessage LookupCache PopulateCache Javascript |
api-config.js api-token-get.js translate-query.js translate-results.js |
| penomoran halaman | Membuat halaman pesan respons XML berdasarkan parameter batas dan offset yang diberikan oleh klien | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| response-cache | Menunjukkan cara menyimpan prakiraan cuaca dalam cache di Edge selama 10 menit. | ResponseCache AssignMessage |
tidak ada |
| simple-python | Menunjukkan skenario sederhana untuk melampirkan skrip python dalam respons yang menambahkan nilai header ke dalamnya. |
Skrip (Python) | setHeader.py |
| sabun | Menunjukkan transformasi XSL yang menulis ulang file WSDL sebagai respons terhadap permintaan dengan parameter kueri ?wsdl. | AssignMessage ExtractVariables Script (Python) XSL |
calculateaddress.py fixwsdl.xsl |
| streaming | Menunjukkan konfigurasi streaming HTTP. | tidak ada | tidak ada |
| target-reroute | Menunjukkan penggunaan JavaScript untuk memilih URL target secara dinamis berdasarkan konten pesan permintaan. | ExtractVariables Javascript |
rewriteTargetUrl.js |
| twitter-mobile-timeline | Menunjukkan cara menggunakan JavaScript untuk menghapus parameter yang tidak diperlukan dari tweet, sehingga menghasilkan linimasa Twitter yang efisien dan cocok untuk perangkat seluler dengan resource terbatas. | AssignMessage Javascript |
MobileTimeline.js |
| twitter-oembed | Mengubah respons linimasa (misalnya, dari statuses/user_timeline.json) menjadi respons oEmbed yang berisi data linimasa sebagai konten HTML kaya. | AssignMessage JavaScript |
search-oembed.js |
| variabel | Menunjukkan cara mengekstrak dan menetapkan variabel berdasarkan konten pesan JSON dan XML serta transport. | AssignMessage ExtractVariables XMLToJSON |
minimize.js |
| xmltojson | Mengonversi data respons dari XML ke JSON. | XMLToJSON JSONToXML |
tidak ada |
|
|
File skema XML yang dapat Anda gunakan sebagai referensi saat mengonfigurasi proxy API, kebijakan, produk API, serta profil developer dan aplikasi. |
||
|
|
Berisi alat deployment, deploy.py, yang mengimpor proxy API ke organisasi di Apigee Edge, lalu men-deploy-nya ke lingkungan yang ditentukan. |
||
|
|
Alat snapshot organisasi mengambil setelan organisasi, termasuk developer, produk API, host virtual, peta key/value, dll. Alat ini dapat digunakan untuk mencadangkan detail organisasi, atau untuk menemukan setelan dalam organisasi. |
Apigee-127
Jika Anda seorang coder, Apigee-127 akan membantu Anda mulai membuat kode proxy API dengan Node.js dan Swagger. Anda juga dapat menemukan contoh a127 di GitHub: https://github.com/apigee-127/a127-samples.
Bagikan pengalaman Anda
Bagikan pengalaman Anda di Forum Developer Apigee.