Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Sampel Apigee Edge API berisi contoh proxy, kebijakan, kode, dan alat API yang menggambarkan kemampuan Layanan Apigee Edge API yang dijelaskan di bawah ini.
Untuk petunjuk tentang penggunaan contoh, lihat Menggunakan contoh proxy API.
Belajar sambil praktik
Ingin terlibat langsung dan mulai membangun basis pengetahuan yang kuat tentang Apigee Edge? Kami memiliki library contoh "learn-edge" di GitHub yang memungkinkan Anda men-deploy, memanggil, dan melacak beberapa contoh proxy dengan cepat, dimulai dengan proxy paling sederhana dan beralih ke proxy yang mengilustrasikan validasi kunci API, kuota, cache respons, penanganan kesalahan, dan lainnya.
Setelah meng-clone repo dan menyiapkan lingkungan (hanya memerlukan waktu beberapa menit), Anda dapat mencoba setiap sampel dalam waktu kurang dari satu menit. Dan karena setiap contoh membuat revisi baru dari proxy yang sama, lingkungan Anda tidak akan dipenuhi dengan banyak sampel. Anda dapat mengalihkan revisi, men-deploy ulang revisi yang berbeda di UI pengelolaan, dan melihat kode proxy kapan saja. Readme untuk setiap sampel juga memberi Anda ringkasan singkat mengenai fungsi sampel dan cara penyiapannya.
Cobalah. https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Contoh buku resep dokumen
Serangkaian contoh disediakan untuk topik buku resep proxy API.
| Nama | Deskripsi | Jenis Kebijakan | Referensi |
|---|---|---|---|
| javascript-cookbook | Mendemonstrasikan cuplikan JavaScript sederhana yang menambahkan header HTTP dari variabel, mengubah laporan cuaca berformat XML dari JSON ke XML, dan memangkas konten untuk klien seluler. | minimal.js setHeaders.js |
|
| javascript-mashup-cookbook | Aplikasi JavaScript lengkap yang melakukan panggilan ke API publik, menggabungkan hasil, dan menghasilkan respons yang diperkaya untuk aplikasi klien. (Catatan: proxy API ini mengimplementasikan fungsi yang sama seperti policy-mashup, yang menunjukkan bahwa masalah yang sama dapat diatasi menggunakan teknik yang berbeda.) | Javascript | MashItUp.js |
| java-hello | Info Java halo dunia sederhana. | JavaCallout | JavaHello.java |
| java-cookbook | Mengonversi konten respons dan header menjadi huruf besar. | JavaCallout |
ResponseUppercase.java |
| java-properties | Menunjukkan cara menggunakan properti dalam info Java. | JavaCallout | JavaProperties.java |
| java-error | Menunjukkan pola penanganan error yang dapat Anda gunakan dalam kode Pemanggilan Java. | JavaCallout | JavaError.java |
| policy-mashup-cookbook | Aplikasi lengkap yang menggunakan komposisi kebijakan untuk memanggil dua API publik, menggabungkan hasil, dan menghasilkan respons yang diperkaya untuk aplikasi klien. (Catatan: proxy API ini menerapkan fungsi yang sama seperti javascript-mashup, yang menunjukkan bahwa masalah yang sama dapat diatasi menggunakan teknik 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 ingin mengetahui cara kerja kebijakan tertentu dalam contohnya, lihat kolom Jenis Kebijakan di bawah untuk jenis kebijakan yang Anda minati, lalu klik nama contoh di kolom Name. (Kebijakan ini ditautkan ke halaman referensinya masing-masing dalam dokumen.)
Referensi dan Alat
Selain contoh buku resep dokumen dan contoh proxy dalam tabel di atas, contoh GitHub Edge juga berisi referensi berikut:
| Nama | Deskripsi | Jenis Kebijakan | Referensi |
|---|---|---|---|
| perlindungan egex | Kebijakan perlindungan ancaman ekspresi reguler dapat melindungi API backend dan microservice Anda dari serangan injeksi SQL. | T/A | |
| oauth-validate-key-secret | Anda menerapkan alur jenis pemberian Sandi OAuth. Anda perlu memvalidasi kunci dan rahasia klien aplikasi di Edge sebelum memanggil Penyedia Identitas di luar untuk memvalidasi kredensial pengguna. | OAuthV2, lainnya | T/A |
| pencocokan kondisi-pola | Proxy ini memungkinkan Anda dengan mudah 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 | Mengimplementasikan validasi kunci API sederhana | VerifyAPIKey AssignMessage Quota |
tidak ada |
| info-asinkron | Mendemonstrasikan info asinkron sederhana menggunakan httpClient JavaScript. | Javascript | assemble_response.js callout.js |
| base64encoder | Menunjukkan cara memanggil JavaScript yang disertakan dari resource JavaScript dalam proxy API. | AssignMessage JavaScript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| conditional-policy | Menerapkan penerapan kebijakan bersyarat yang sederhana. Jika permintaan berisi responsetime:true header HTTP, kebijakan akan menjalankan skrip Python yang menambahkan serangkaian metrik performa ke pesan respons tersebut, sebagai header HTTP | Skrip (Python) | timer.py |
| dynamic-endpoint | Menerapkan pemilihan rute bersyarat yang 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 dokumen Apigee untuk membuat catatan rilis dari Jira. | JSONToXML XSL |
releasenotes_api.xsl |
| kerberos-credential-mediasi | 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 kode contoh |
| kredensial-oauth-client | Mendemonstrasikan endpoint token OAuth 2.0 yang berfungsi sepenuhnya yang dikonfigurasi untuk jenis pemberian kredensial klien. | GenerateAccessToken | tidak ada |
| oauth-login-app | Tidak digunakan lagi. Sebaiknya lihat sampel oauth-advanced. | ||
| oauth-validate-key-secret | Menggambarkan teknik untuk memvalidasi kunci dan rahasia klien sebelum memanggil penyedia identitas untuk memvalidasi kredensial pengguna dalam alur jenis pemberian sandi. | OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault |
tidak ada |
| oauth-verify-accesstoken | Mendemonstrasikan proxy API yang dikonfigurasi untuk memvalidasi token akses OAuth 2.0 dan memverifikasi Kuota. | VerifyAccessToken Kuota |
tidak ada |
| oauth10a-3legged | Mendemonstrasikan konfigurasi tiga cabang OAuth 1.0a. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
tidak ada |
| outbound-oauth | Menggunakan Microsoft Azure Translations API untuk menerjemahkan tweet. Untuk melakukannya, Chrome membuat panggilan keluar untuk mendapatkan token akses OAuth, lalu meng-cache token menggunakan kebijakan caching Layanan API, 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 | Memberi nomor pada pesan respons XML berdasarkan batas dan parameter offset yang disediakan oleh klien | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| cache-respons | Menunjukkan cara menyimpan prakiraan cuaca dalam cache di Edge selama 10 menit. | ResponseCache AssignMessage |
tidak ada |
| simple-python | Mendemonstrasikan skenario sederhana untuk melampirkan skrip phyton dalam respons yang menambahkan nilai header ke dalamnya. |
Skrip (Python) | setHeader.py |
| sabun | Mendemonstrasikan transformasi XSL yang menulis ulang file WSDL sebagai respons terhadap permintaan dengan parameter kueri ?wsdl. | AssignMessage ExtractVariables Skrip (Python) XSL |
hitungaddress.py fixwsdl.xsl |
| streaming | Mendemonstrasikan konfigurasi streaming HTTP. | tidak ada | tidak ada |
| perubahan rute target | Mendemonstrasikan 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, menghasilkan linimasa Twitter yang disederhanakan yang cocok untuk perangkat seluler dengan resource yang terbatas. | AssignMessage JavaScript |
MobileTimeline.js |
| twitter-oembed | Mengubah respons linimasa (misalnya, dari status/user_timeline.json) menjadi respons oEmbed yang berisi data linimasa sebagai konten HTML lengkap. | AssignMessage JavaScript |
search-oembed.js |
| variabel | Mendemonstrasikan cara mengekstrak dan menetapkan variabel berdasarkan transpor serta isi pesan JSON dan XML. | 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 kunci/nilai, dll. Alat ini dapat digunakan untuk mencadangkan detail organisasi, atau untuk menemukan setelan dalam suatu organisasi. |
Apigee-127
Jika Anda seorang coder, Apigee-127 akan menyiapkan Anda dan 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.