Daftar sampel

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

Contoh Apigee Edge API berisi contoh proxy, kebijakan, kode, dan alat API yang menggambarkan kemampuan Layanan API Apigee Edge yang dijelaskan di bawah.

Untuk petunjuk cara menggunakan contoh, lihat Menggunakan contoh proxy API.

Belajar sambil melakukan praktik

Ingin langsung mencoba 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 contoh proxy dengan cepat, mulai dari proxy yang paling sederhana dan beralih ke proxy yang menggambarkan validasi kunci API, kuota, caching respons, penanganan error, dan lainnya.

Setelah meng-clone repo dan menyiapkan lingkungan (hanya perlu beberapa menit), Anda dapat mencoba setiap sampel dalam kurang dari satu menit. Selain itu, karena setiap sampel membuat revisi baru dari proxy yang sama, lingkungan Anda tidak akan penuh dengan banyak sampel. Anda dapat beralih revisi, men-deploy ulang revisi lain di UI pengelolaan, dan melihat kode proxy kapan saja. Readme untuk setiap contoh juga memberikan ringkasan singkat tentang apa yang dilakukan contoh tersebut dan cara penyiapannya.

Coba sekarang! https://github.com/apigee/api-platform-samples/tree/master/learn-edge

Contoh cookbook dokumen

Kumpulan contoh disediakan untuk topik cookbook 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 menjadi XML, dan memangkas konten untuk klien seluler.

JavaScript
XMLToJSON

minimize.js
setHeaders.js
javascript-mashup-cookbook Aplikasi JavaScript lengkap yang memanggil API publik, menggabungkan hasil, dan menghasilkan respons yang diperkaya 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 Pemanggilan 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 info Java. JavaCallout JavaProperties.java
java-error Menunjukkan pola penanganan error yang dapat Anda gunakan dalam kode Java Callout. 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 dengan mashup javascript, yang menunjukkan bahwa masalah yang sama dapat diatasi menggunakan teknik yang berbeda.) AssignMessage
ServiceCallout
ExtractVariables
Javascript
XMLToJSON
GenerateResponse.js

Contoh proxy API

Proksi API berikut terletak di GitHub, tempat halaman readme memberikan deskripsi contoh yang mendetail. Jika Anda tertarik dengan cara kerja kebijakan tertentu dalam contoh, cari di kolom Jenis Kebijakan di bawah untuk menemukan kebijakan yang Anda minati, lalu klik nama contoh di kolom Nama. (Kebijakan ditautkan ke halaman referensi masing-masing dalam dokumen.)

Referensi dan Alat

Selain contoh cookbook dokumen dan contoh proxy dalam tabel di atas, contoh GitHub Edge juga berisi resource berikut:

Nama Deskripsi Jenis Kebijakan Resource
regex-protection Kebijakan perlindungan terhadap ancaman ekspresi reguler dapat melindungi API backend dan microservice Anda dari serangan injeksi SQL.

Perlindungan Ekspresi Reguler

T/A
oauth-validate-key-secret Anda menerapkan alur jenis pemberian Sandi OAuth. Anda perlu memvalidasi kunci klien dan secret aplikasi di Edge sebelum memanggil Penyedia Identitas di luar untuk memvalidasi kredensial pengguna. OAuthV2, lainnya T/A
condition-pattern-matching Proxy ini memungkinkan Anda mencoba dan menguji pernyataan kondisional dalam alur proxy API dengan mudah. 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
async-callout Menunjukkan callout 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 penerapan kebijakan bersyarat yang sederhana. Jika permintaan berisi header HTTP responsetime:true, kebijakan akan mengeksekusi skrip Python yang menambahkan kumpulan metrik performa ke pesan respons, sebagai header HTTP Skrip (Python) timer.py
dynamic-endpoint Mengimplementasikan 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 dokumen 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
GenerateAuthCode
RefreshAccessToken

Banyak lagi...

lihat kode contoh
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 Menggambarkan 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
Kuota
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, API ini melakukan panggilan keluar untuk mendapatkan token akses OAuth, lalu meng-cache token menggunakan kebijakan penyimpanan cache Layanan API, yang 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 penomoran 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 ramalan cuaca di Edge ke dalam cache 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 disederhanakan 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 yang kaya. AssignMessage
JavaScript
search-oembed.js
variabel Menunjukkan cara mengekstrak dan menetapkan variabel berdasarkan konten pesan JSON dan XML serta transportasi. AssignMessage
ExtractVariables
XMLToJSON
minimize.js
xmltojson Mengonversi data respons dari XML ke JSON. XMLToJSON
JSONToXML
tidak ada

/schemas

File skema XML yang dapat Anda gunakan sebagai referensi saat mengonfigurasi proxy API, kebijakan, produk API, serta profil developer dan aplikasi.

/tools

Berisi alat deployment, deploy.py, yang mengimpor proxy API ke organisasi di Apigee Edge, lalu men-deploy-nya ke lingkungan yang ditentukan.

/org-snapshot

Alat snapshot organisasi mengambil setelan organisasi, termasuk developer, produk API, host virtual, peta nilai kunci, dll. Alat ini dapat digunakan untuk mencadangkan detail organisasi, atau menemukan setelan di organisasi.

Apigee-127

Jika Anda seorang coder, Apigee-127 akan membantu Anda menyiapkan 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.