Referensi konfigurasi proxy API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Sebagai developer yang bekerja dengan Apigee, aktivitas pengembangan utama Anda melibatkan konfigurasi proxy API yang berfungsi sebagai proxy untuk API atau layanan backend. Dokumen ini merupakan referensi semua elemen konfigurasi yang tersedia untuk Anda saat membangun proxy API.

Jika Anda mempelajari cara membangun proxy API, sebaiknya mulai dengan topik Membuat proxy API sederhana.

Edit konfigurasi proxy API Anda menggunakan salah satu metode berikut:

• Gunakan UI atau API Apigee.
• Download paket konfigurasi proxy API, edit secara manual, dan upload konfigurasi baru ke Apigee, seperti yang dijelaskan dalam Mendownload dan mengupload paket konfigurasi proxy API.

Struktur direktori konfigurasi proxy API

Struktur direktori konfigurasi proxy API ditampilkan di bawah ini:

Konfigurasi proxy API terdiri dari konten berikut:

Konfigurasi dasar	Setelan konfigurasi utama untuk proxy API.
ProxyEndpoint	Setelan untuk koneksi HTTP masuk (dari meminta aplikasi ke Apigee), alur permintaan dan respons, serta lampiran kebijakan.
TargetEndpoint	Setelan untuk koneksi HTTP keluar (dari Apigee ke layanan backend), alur permintaan dan respons, serta lampiran kebijakan.
Alur	Pipeline permintaan dan respons ProxyEndpoint dan TargetEndpoint yang dapat dikaitkan dengan kebijakan.
Kebijakan	File konfigurasi berformat XML yang sesuai dengan skema kebijakan Apigee.
Resource	Skrip, file JAR, dan file XSLT yang dirujuk oleh kebijakan untuk menjalankan logika kustom.

Konfigurasi dasar

/apiproxy/weatherapi.xml

Konfigurasi dasar untuk proxy API, yang menentukan nama proxy API. Nama harus unik dalam suatu organisasi.

Contoh konfigurasi:

<APIProxy name="weatherapi">
</APIProxy>

Elemen konfigurasi dasar

Name	Deskripsi	Default	Wajib?
APIProxy
name	Nama proxy API yang harus unik dalam suatu organisasi. Karakter yang boleh Anda gunakan dalam nama dibatasi untuk hal berikut: A-Za-z0-9_-	T/A	Ya
revision	Nomor revisi konfigurasi proxy API. Anda tidak perlu menetapkan nomor revisi secara eksplisit, karena Apigee secara otomatis melacak revisi proxy API saat ini.	T/A	Tidak
ConfigurationVersion	Versi skema konfigurasi proxy API yang sesuai dengan proxy API ini. Satu-satunya nilai yang didukung saat ini adalah primaryVersion 4 dan minorVersion 0. Setelan ini dapat digunakan pada masa mendatang untuk memungkinkan evolusi format proxy API.	4.0	Tidak
Description	Deskripsi tekstual proxy API. Jika disediakan, deskripsi akan ditampilkan di UI Apigee.	T/A	Tidak
DisplayName	Nama yang mudah digunakan yang mungkin berbeda dari atribut name konfigurasi proxy API.	T/A	Tidak
Policies	Daftar kebijakan dalam direktori /policies proxy API ini. Biasanya Anda hanya akan melihat elemen ini saat proxy API dibuat menggunakan UI Apigee. Ini hanyalah setelan manifes, yang dirancang untuk memberikan visibilitas ke konten proxy API.	T/A	Tidak
ProxyEndpoints	Daftar endpoint proxy dalam direktori /proxies proxy API ini. Biasanya Anda hanya akan melihat elemen ini saat proxy API dibuat menggunakan UI Apigee. Ini hanyalah setelan manifes, yang dirancang untuk memberikan visibilitas ke dalam konten proxy API.	T/A	Tidak
Resources	Daftar resource (JavaScript, Python, Java, XSLT) dalam direktori /resources proxy API ini. Biasanya Anda hanya akan melihat elemen ini saat proxy API dibuat menggunakan UI Apigee. Ini hanyalah setelan manifes, yang dirancang untuk memberikan visibilitas ke konten proxy API.	T/A	Tidak
Spec	Mengidentifikasi Spesifikasi OpenAPI yang terkait dengan proxy API. Nilai ditetapkan ke URL atau jalur di penyimpanan spesifikasi.	T/A	Tidak
TargetServers	Daftar server target yang dirujuk di endpoint target mana pun dari proxy API ini. Biasanya Anda hanya akan melihat elemen ini saat proxy API dibuat menggunakan Apigee. Ini hanyalah setelan manifes, yang dirancang untuk memberikan visibilitas ke konten proxy API.	T/A	Tidak
TargetEndpoints	Daftar endpoint target dalam direktori /targets proxy API ini. Biasanya Anda hanya akan melihat elemen ini saat proxy API dibuat menggunakan UI Apigee. Ini hanyalah setelan manifes, yang dirancang untuk memberikan visibilitas ke dalam konten proxy API.	T/A	Tidak

ProxyEndpoint

Gambar berikut menunjukkan alur permintaan/respons:

/apiproxy/proxies/default.xml

Konfigurasi ProxyEndpoint menentukan antarmuka masuk (dihadap klien) untuk proxy API. Saat mengonfigurasi endpoint proxy, Anda sedang menyiapkan konfigurasi jaringan yang menentukan cara aplikasi klien (aplikasi) memanggil API yang di-proxy-kan.

Contoh konfigurasi ProxyEndpoint berikut akan disimpan di /apiproxy/proxies:

<ProxyEndpoint name="default">
  <PreFlow/>
  <Flows/>
  <PostFlow/>
  <HTTPProxyConnection>
    <BasePath>/weather</BasePath>
    <Properties/>
  </HTTPProxyConnection>
  <FaultRules/>
  <DefaultFaultRule/>
  <RouteRule name="default">
    <TargetEndpoint>default</TargetEndpoint>
  </RouteRule>
</ProxyEndpoint>

Elemen konfigurasi yang diperlukan di endpoint proxy dasar adalah:

Elemen konfigurasi ProxyEndpoint

Name	Deskripsi	Default	Wajib?
ProxyEndpoint
name	Nama endpoint proxy. Harus unik dalam konfigurasi proxy API, jika (dalam kasus yang jarang terjadi) beberapa endpoint proxy ditentukan. Karakter yang boleh Anda gunakan dalam nama dibatasi untuk hal berikut: A-Za-z0-9._\-$ %.	T/A	Ya
PreFlow	Menentukan kebijakan dalam alur PreFlow permintaan atau respons.	T/A	Ya
Flows	Menentukan kebijakan dalam alur bersyarat sebuah permintaan atau respons.	T/A	Ya
PostFlow	Menentukan kebijakan dalam alur PostFlow dari permintaan atau respons.	T/A	Ya
HTTPProxyConnection	Menentukan alamat jaringan dan jalur URI yang terkait dengan proxy API.
BasePath	String wajib yang mengidentifikasi secara unik jalur URI yang digunakan oleh Apigee untuk merutekan pesan masuk ke proxy API yang tepat. BasePath adalah fragmen URI (misalnya /weather) yang ditambahkan ke URL dasar proxy API (misalnya http://apifactory-test.apigee.net). BasePath harus unik dalam suatu lingkungan. Keunikan divalidasi saat proxy API dibuat atau diimpor. Menggunakan karakter pengganti di jalur dasar Anda dapat menggunakan satu atau beberapa karakter pengganti "*" di jalur dasar proxy API. Misalnya, jalur dasar /team/*/members memungkinkan klien memanggil https://[host]/team/blue/members dan https://[host]/team/green/members tanpa Anda perlu membuat proxy API baru untuk mendukung tim baru. Perhatikan bahwa /**/ tidak didukung. Penting: Apigee TIDAK mendukung penggunaan karakter pengganti "*" sebagai elemen pertama dari jalur dasar. Misalnya, ini TIDAK didukung: /*/search. Memulai jalur dasar dengan "*" dapat menyebabkan error tak terduga karena cara Apigee mengidentifikasi jalur yang valid.	/	Ya
Properties	Serangkaian setelan konfigurasi HTTP opsional dapat ditentukan sebagai properti <ProxyEndpoint>. Gunakan properti request.queryparams.ignore.content.type.charset untuk memberi tahu proxy agar mengabaikan parameter charset dari header Content-Type saat memproses URL permintaan. Contoh: <Property name= \ "request.queryparams.ignore.content.type.charset">true</> Tabel berikut menunjukkan contoh output, bergantung pada setelan properti charset dan keberadaan parameter charset header Content-Type. Setelan properti Nilai header Contoh output charset=false Parameter charset tidak ditetapkan [e-mail] charset=false charset=utf-8 john.doe [e-mail] charset=true dan tidak ada parameter charset di header. Parameter charset tidak ditetapkan [e-mail] charset=true charset=utf-8 kumpulan parameter [e-mail]	T/A	Tidak
FaultRules	Menentukan cara endpoint proxy bereaksi terhadap error. Aturan kesalahan menentukan dua item: Kondisi yang menentukan kesalahan yang akan ditangani berdasarkan kategori, subkategori, atau nama kesalahan yang telah ditentukan sebelumnya Satu atau beberapa kebijakan yang menentukan perilaku aturan kesalahan untuk Kondisi yang sesuai Lihat Menangani kesalahan.	T/A	Tidak
DefaultFaultRule	Menangani error (sistem, transport, pesan, atau kebijakan) yang tidak secara eksplisit ditangani oleh aturan kesalahan lain. Lihat Menangani kesalahan.	T/A	Tidak
RouteRule	Menentukan tujuan pesan permintaan masuk setelah diproses oleh pipeline permintaan ProxyEndpoint. Biasanya, RouteRule mengarah ke endpoint target yang telah diberi nama, IntegrationEndpoint, atau URL.
Name	Atribut wajib, yang memberikan nama untuk RouteRule. Karakter yang diizinkan untuk Anda gunakan dalam nama dibatasi untuk hal berikut: A-Za-z0-9._\-$ %. Misalnya, Cat2 %_ adalah nama resmi.	T/A	Ya
Condition	Pernyataan kondisional opsional yang digunakan untuk perutean dinamis saat runtime. RouteRules bersyarat berguna, misalnya, untuk mengaktifkan perutean berbasis konten guna mendukung pembuatan versi backend.	T/A	Tidak
TargetEndpoint	String opsional yang mengidentifikasi konfigurasi TargetEndpoint bernama. Endpoint target bernama adalah endpoint target apa pun yang ditentukan dalam proxy API yang sama pada direktori /targets). Dengan memberi nama endpoint target, Anda menunjukkan tempat pesan permintaan harus diteruskan setelah diproses oleh pipeline permintaan ProxyEndpoint. Perhatikan bahwa ini adalah setelan opsional. Endpoint proxy dapat memanggil URL secara langsung. Misalnya, resource JavaScript atau Java, yang berfungsi dalam peran klien HTTP, dapat menjalankan tugas dasar endpoint target, yaitu meneruskan permintaan ke layanan backend.	T/A	Tidak
URL	String opsional yang menentukan alamat jaringan keluar yang dipanggil oleh endpoint proxy, yang mengabaikan konfigurasi TargetEndpoint yang mungkin disimpan di /targets	T/A	Tidak

Cara mengonfigurasi RouteRules

Endpoint target bernama merujuk pada file konfigurasi di bagian /apiproxy/targets yang akan digunakan RouteRule untuk meneruskan permintaan setelah diproses oleh endpoint proxy.

Misalnya, RouteRule berikut merujuk pada konfigurasi /apiproxy/targets/myTarget.xml:

<RouteRule name="default">
  <TargetEndpoint>myTarget</TargetEndpoint>
</RouteRule>

Pemanggilan URL langsung

Endpoint proxy juga dapat langsung memanggil layanan backend. Pemanggilan URL langsung mengabaikan konfigurasi TargetEndpoint bernama apa pun di /apiproxy/targets). Oleh karena itu, TargetEndpoint adalah konfigurasi proxy API opsional, meskipun dalam praktiknya, pemanggilan langsung dari endpoint proxy tidak direkomendasikan.

Misalnya, RouteRule berikut membuat panggilan HTTP ke http://api.mycompany.com/v2.

<RouteRule name="default">
  <URL>http://api.mycompany.com/v2</URL> 
</RouteRule>

Rute bersyarat

RouteRules dapat dirantai untuk mendukung perutean dinamis saat runtime. Permintaan masuk dapat dirutekan ke konfigurasi TargetEndpoint bernama, langsung ke URL, atau kombinasi keduanya, berdasarkan header HTTP, konten pesan, parameter kueri, atau informasi kontekstual seperti waktu, lokalitas, dll.

RouteRules berfungsi seperti pernyataan kondisional lainnya di Apigee. Lihat Referensi kondisi dan Referensi variabel flow.

Misalnya, kombinasi RouteRule berikut terlebih dahulu mengevaluasi permintaan masuk untuk memverifikasi nilai header HTTP. Jika header HTTP routeTo memiliki nilai TargetEndpoint1, permintaan akan diteruskan ke endpoint target yang bernama TargetEndpoint1. Jika tidak, permintaan masuk akan diteruskan ke http://api.mycompany.com/v2.

<RouteRule name="MyRoute">
  <Condition>request.header.routeTo = "TargetEndpoint1"</Condition>
  <TargetEndpoint>TargetEndpoint1</TargetEndpoint>
</RouteRule>
<RouteRule name="default">
  <URL>http://api.mycompany.com/v2</URL>
</RouteRule>

Catatan: Pemilihan rute yang lebih dinamis

Artikel komunitas Apigee yang menentukan endpoint proxy menunjukkan perutean dinamis ke berbagai region dunia berdasarkan variabel yang diekstrak dari URI permintaan.

Rute null

RouteRule null dapat ditentukan untuk mendukung skenario ketika pesan permintaan tidak perlu diteruskan ke endpoint target. Hal ini berguna saat endpoint proxy melakukan semua pemrosesan yang diperlukan, misalnya dengan menggunakan JavaScript untuk memanggil layanan eksternal atau mengambil data dari pencarian ke penyimpanan kunci/nilai Apigee.

Misalnya, hal berikut menentukan Rute null:

<RouteRule name="GoNowhere"/>

Rute null bersyarat dapat berguna. Pada contoh berikut, Rute null dikonfigurasi untuk dijalankan saat request.header.X-DoNothing header HTTP memiliki nilai selain null.

<RouteRule name="DoNothingOnDemand">
  <Condition>request.header.X-DoNothing != null</Condition>
</RouteRule>

Ingat, RouteRules dapat dirantai, sehingga Rute null kondisional biasanya menjadi satu komponen dari kumpulan RouteRules yang dirancang untuk mendukung perutean bersyarat.

Penggunaan praktis Rute null bersyarat akan mendukung caching. Dengan menggunakan nilai variabel yang ditetapkan oleh kebijakan Cache, Anda dapat mengonfigurasi proxy API untuk menjalankan Rute null saat entri disajikan dari cache.

<RouteRule name="DoNothingUnlessTheCacheIsStale">
  <Condition>lookupcache.LookupCache-1.cachehit is true</Condition>
</RouteRule>

TargetEndpoint

Endpoint target adalah endpoint yang setara dengan endpoint proxy. Endpoint target berfungsi sebagai klien ke layanan backend atau API. Endpoint ini mengirim permintaan dan menerima respons.

Proxy API tidak perlu memiliki endpoint target. Endpoint proxy dapat dikonfigurasi untuk memanggil URL secara langsung. Proxy API tanpa endpoint target biasanya berisi endpoint proxy yang secara langsung memanggil layanan backend, atau yang dikonfigurasi untuk memanggil layanan menggunakan Java atau JavaScript.

Konfigurasi TargetEndpoint

/targets/default.xml

Endpoint target menentukan koneksi keluar dari Apigee ke layanan atau resource lainnya.

Berikut adalah contoh konfigurasi TargetEndpoint:

<TargetEndpoint name="default">
  <PreFlow/>
  <Flows/>
  <PostFlow/>
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
    <SSLInfo/>
    <Authentication/>
  </HTTPTargetConnection>
  <FaultRules/>
  <DefaultFaultRule/>
  <ScriptTarget/>
  <LocalTargetConnection/>
</TargetEndpoint>

Elemen konfigurasi TargetEndpoint

Endpoint target dapat memanggil target dengan salah satu cara berikut:

• HTTPTargetConnection untuk panggilan HTTP atau HTTPS
• LocalTargetConnection untuk rantai proxy-ke-proxy lokal

Hanya konfigurasi salah satunya di endpoint target.

Name	Deskripsi	Default	Wajib?
TargetEndpoint
name	Nama endpoint target, yang harus unik dalam konfigurasi proxy API. Nama endpoint target digunakan dalam ProxyEndpoint RouteRule untuk mengarahkan permintaan langsung untuk pemrosesan keluar. Karakter yang boleh Anda gunakan dalam nama dibatasi untuk hal berikut: A-Za-z0-9._\-$ %.	T/A	Ya
PreFlow	Menentukan kebijakan dalam alur PreFlow permintaan atau respons.	T/A	Ya
Flows	Menentukan kebijakan dalam alur bersyarat sebuah permintaan atau respons.	T/A	Ya
PostFlow	Menentukan kebijakan dalam alur PostFlow dari permintaan atau respons.	T/A	Ya
HTTPTargetConnection	Dengan elemen turunannya, menentukan resource backend yang dijangkau melalui HTTP. Jika Anda menggunakan HTTPTargetConnection, jangan konfigurasikan jenis koneksi target lainnya (ScriptTarget atau LocalTargetConnection). Catatan: Elemen <LocalTargetConnection> mendukung fitur substitusi string dinamis yang disebut template pesan. Anda dapat menggunakan elemen turunan <Authentication> untuk melakukan panggilan terautentikasi ke layanan Google atau layanan khusus yang berjalan di produk Google Cloud tertentu, seperti Cloud Functions dan Cloud Run. Penggunaan elemen <Authentication> memerlukan langkah-langkah penyiapan dan deployment yang dijelaskan dalam Menggunakan autentikasi Google. Dengan penyiapan yang tepat, kebijakan tersebut akan membuat token autentikasi untuk Anda dan menambahkannya ke permintaan layanan. Lihat juga Penggunaan elemen <Authentication>.
URL	Menentukan alamat jaringan layanan backend yang menjadi tujuan penerusan pesan permintaan oleh endpoint target.	T/A	Tidak
LoadBalancer	Menentukan satu atau beberapa konfigurasi TargetServer yang bernama. Konfigurasi TargetServer bernama dapat digunakan untuk load balancing yang menentukan 2 koneksi konfigurasi endpoint atau lebih. Anda juga dapat menggunakan server target untuk memisahkan konfigurasi proxy API dari URL endpoint layanan backend konkret.	T/A	Tidak
Properties	Serangkaian setelan konfigurasi HTTP opsional dapat ditentukan sebagai properti <TargetEndpoint>.	T/A	Tidak
SSLInfo	Secara opsional, tetapkan setelan TLS/SSL pada endpoint target untuk mengontrol koneksi TLS/SSL antara proxy API dan layanan target. Lihat Konfigurasi TargetEndpoint TLS/SSL. Catatan: Elemen <SSLInfo> mendukung fitur substitusi string dinamis yang disebut template pesan.	T/A	Tidak
LocalTargetConnection	Dengan elemen turunannya, menentukan resource yang akan dijangkau secara lokal, dengan mengabaikan karakteristik jaringan seperti load balancing dan pemroses pesan. Untuk menentukan resource target, sertakan elemen turunan APIProxy (dengan elemen ProxyEndpoint) atau elemen turunan Path. Untuk informasi selengkapnya, lihat Merantai proxy API bersama-sama. Jika Anda menggunakan LocalTargetConnection, jangan konfigurasikan jenis koneksi target lainnya (HTTPTargetConnection atau ScriptTarget).
APIProxy	Menentukan nama proxy API yang akan digunakan sebagai target permintaan. Proxy target harus berada dalam organisasi dan lingkungan yang sama dengan permintaan pengiriman proxy. Ini adalah alternatif untuk menggunakan elemen Jalur.	T/A	Tidak
ProxyEndpoint	Digunakan dengan APIProxy untuk menentukan nama endpoint proxy proxy target.	T/A	Tidak
Path	Menentukan jalur endpoint proxy API yang akan digunakan sebagai target untuk permintaan. Proxy target harus berada dalam organisasi dan lingkungan yang sama dengan permintaan pengiriman proxy. Ini adalah alternatif untuk menggunakan APIProxy.	T/A	Tidak
FaultRules	Menentukan bagaimana endpoint target bereaksi terhadap error. Aturan kesalahan menentukan dua item: Kondisi yang menentukan kesalahan yang akan ditangani berdasarkan kategori, subkategori, atau nama kesalahan yang telah ditentukan sebelumnya Satu atau beberapa kebijakan yang menentukan perilaku aturan kesalahan untuk Kondisi yang sesuai Lihat Menangani kesalahan.	T/A	Tidak
DefaultFaultRule	Menangani error (sistem, transport, pesan, atau kebijakan) yang tidak secara eksplisit ditangani oleh FaultRule lain. Lihat Menangani kesalahan.	T/A	Tidak

Penggunaan elemen <Authentication>

Penggunaan elemen <Authentication> di <TargetEndpoint> identik dengan penggunaan elemen <Authentication> dalam kebijakan Servicecallout. Di <TargetEndpoint> dan Servicecallout, <Authentication> adalah subelemen dari <HttpTargetConnection>. Untuk mengetahui detailnya, lihat Elemen Authentication di referensi kebijakan Service callout.

Referensi error elemen <Authentication>

Jika menggunakan elemen <Authentication>, Anda dapat menemukan kemungkinan pesan error dan tips pemecahan masalah untuk error deployment dan runtime di bagian Error dalam dokumentasi kebijakan Servicecallout.

Contoh elemen <Authentication>

Contoh berikut menunjukkan cara memanggil layanan yang di-deploy di Cloud Run sebagai target menggunakan elemen Authentication untuk menghasilkan token OpenID Connect yang diperlukan guna mengautentikasi panggilan:

<TargetEndpoint name="TargetEndpoint-1">
  <HTTPTargetConnection>
      <Properties/>
      <URL>https://cloudrun-hostname.a.run.app/test</URL>
      <Authentication>
          <GoogleIDToken>
             <Audience>https://cloudrun-hostname.a.run.app/test</Audience>
          </GoogleIDToken>
     </Authentication>
  </HTTPTargetConnection>
</TargetEndpoint>

Contoh berikut menunjukkan cara memanggil TargetService yang mengarah ke Cloud Run menggunakan elemen Authentication untuk menghasilkan token OpenID Connect yang diperlukan guna mengautentikasi panggilan. Elemen HeaderName menambahkan token pemilik yang dihasilkan ke header bernama X-Serverless-Authorization yang dikirim ke sistem target. Header Authorization, jika ada, tidak boleh diubah dan juga dikirim dalam permintaan.

<TargetEndpoint name="TargetEndpoint-1">
   <HTTPTargetConnection>
     <Authentication>
        <HeaderName>X-Serverless-Authorization</HeaderName>
        <GoogleIDToken>
            <Audience ref="flow.variable.audience">https://cloudrun-hostname.a.run.app</Audience>
        </GoogleIDToken>
     </Authentication>
      <LoadBalancer>
         <Server name="cloud-run-target" />
      </LoadBalancer>
   </HTTPTargetConnection>
</TargetEndpoint>

Contoh berikut menunjukkan cara memanggil TargetService yang mengarah ke layanan Google Secret Manager. Dalam contoh ini, elemen GoogleAccessToken dikonfigurasi untuk menghasilkan Token Google Auth guna mengautentikasi permintaan target:

<HTTPTargetConnection>
   <Authentication>
      <GoogleAccessToken>
        <Scopes>
          <Scope>https://www.googleapis.com/auth/cloud-platform</Scope>
        </Scopes>
      </GoogleAccessToken>
    </Authentication>
    <URL>
      https://secretmanager.googleapis.com/v1/projects/project-id/secrets/secret-id
    </URL>
</HTTPTargetConnection>

Contoh berikut menunjukkan cara menetapkan audiens GoogleIDToken secara otomatis. Jika useTargetUrl adalah true dan variabel yang direferensikan tidak di-resolve menjadi variabel yang valid, URL target (tidak termasuk parameter kueri) akan digunakan sebagai audiens. Misalkan jalur permintaan adalah /foobar dan URL server target adalah https://xyz.com, audiens GoogleIDToken akan otomatis ditetapkan ke https://xyz.com/foobar.

Pengguna Apigee Hybrid: Jika Anda menggunakan Apigee Hybrid, perhatikan bahwa atribut useTargetUrl tersedia di Apigee Hybrid versi 1.8 dan yang lebih baru.

<TargetEndpoint name="TargetEndpoint-1">
  <HTTPTargetConnection>
    <Authentication>
      <GoogleIDToken>
        <Audience ref='myvariable' useTargetUrl="true"/>
      </GoogleIDToken>
    </Authentication>
    <LoadBalancer>
      <Server name="TS" />
    </LoadBalancer>
  </HTTPTargetConnection>
</TargetEndpoint>

Konfigurasi TargetEndpoint TLS/SSL

Endpoint target sering kali perlu mengelola koneksi HTTPS dengan infrastruktur backend yang heterogen. Karena alasan ini, sejumlah setelan konfigurasi TLS/SSL didukung.

Catatan: TLS (Transport Layer Security) adalah versi terbaru dari spesifikasi SSL (Secure Sockets Layer) yang kini tidak digunakan lagi. Karena Apigee awalnya mendukung SSL, Anda mungkin melihat beberapa instance di UI Apigee dan di elemen konfigurasi Apigee yang menggunakan istilah SSL. Namun, Apigee menggunakan TLS secara eksklusif.

Elemen konfigurasi TargetEndpoint TLS/SSL

Name	Deskripsi	Default	Wajib?
SSLInfo	Blok <SSLInfo> dapat digunakan untuk TLS/SSL satu arah dan dua arah.
Enabled	Jika ditetapkan ke true, <Enabled> menentukan bahwa blok <SSLInfo> harus digunakan. Jika ditetapkan ke false, blok <SSLInfo> akan diabaikan. Nilai default <Enabled> adalah true jika <URL> menentukan protokol HTTPS, dan false jika <URL> menentukan HTTP.	benar (true) jika <URL> menentukan HTTPS	Tidak
Enforce	Menerapkan SSL ketat antara Apigee dan backend target. Jika disetel ke true, koneksi akan gagal untuk target dengan sertifikat tidak valid, sertifikat yang habis masa berlakunya, sertifikat yang ditandatangani sendiri, sertifikat dengan ketidakcocokan nama host, dan sertifikat dengan root yang tidak tepercaya. Kode kegagalan 4xx atau 5xx akan ditampilkan. Jika tidak disetel atau disetel ke false, hasil koneksi ke backend target dengan sertifikat yang bermasalah akan bergantung pada setelan <IgnoreValidationErrors> (lihat di bawah). Respons berhasil (2xx) dapat terjadi dalam kondisi tertentu, jika <IgnoreValidationErrors> disetel ke true.	false	Tidak
TrustStore	Keystore yang berisi sertifikat server root tepercaya. Apigee akan memperlakukan peer jarak jauh sebagai tepercaya jika rantai sertifikat yang dikirimnya berhenti di sertifikat yang terdapat dalam keystore ini.	T/A	Tidak
ClientAuthEnabled	Jika ditetapkan ke true, TLS dua arah (juga dikenal sebagai TLS atau mTLS bersama) akan diaktifkan antara Apigee dan peer jarak jauh, baik klien API maupun backend target. Mengaktifkan TLS dua arah biasanya mengharuskan Anda menyiapkan truststore dan keystore di Apigee.	false	Tidak
KeyStore	Keystore yang berisi kunci pribadi yang digunakan untuk autentikasi klien keluar	T/A	Ya (jika ClientAuthEnabled benar)
KeyAlias	Alias kunci dari kunci pribadi yang digunakan untuk autentikasi klien keluar	T/A	Ya (jika ClientAuthEnabled benar)
IgnoreValidationErrors	Menunjukkan apakah error validasi diabaikan. Jika sistem backend menggunakan SNI dan menampilkan sertifikat dengan subjek Nama yang Dibedakan (DN) yang tidak cocok dengan nama host, tidak ada cara untuk mengabaikan error dan koneksi akan gagal. Catatan: Jika <Enforce> ditetapkan ke true, nilai <IgnoreValidationErrors> akan diabaikan.	false	Tidak
Ciphers	Cipher yang didukung untuk TLS/SSL keluar. Jika tidak ada cipher yang ditentukan, semua cipher yang tersedia untuk JVM akan diizinkan. Untuk membatasi cipher, tambahkan elemen berikut yang mencantumkan cipher yang didukung: <Ciphers> <Cipher>TLS_RSA_WITH_3DES_EDE_CBC_SHA</Cipher> <Cipher>TLS_RSA_WITH_DES_CBC_SHA</Cipher> </Ciphers>	T/A	Tidak
Protocols	Protokol yang didukung untuk TLS/SSL keluar. Jika tidak ada protokol yang ditentukan, maka semua protokol yang tersedia untuk JVM akan diizinkan. Untuk membatasi protokol, tentukan secara eksplisit. Misalnya, untuk hanya mengizinkan TLS v1.2 atau TLS v1.3: <Protocols> <Protocol>TLSv1.2</Protocol> <Protocol>TLSv1.3</Protocol> </Protocols>	T/A	Tidak
CommonName	Apigee memeriksa nilai di sini berdasarkan CN (Nama Umum) atau SAN (Nama Alternatif Subjek) pada sertifikat peer jarak jauh.	T/A	Tidak

Contoh endpoint target dengan autentikasi klien keluar diaktifkan

<TargetEndpoint name="default">
  <HttpTargetConnection>
        <URL>https://myservice.com</URL>
    <SSLInfo>
      <Enabled>true</Enabled>
      <Enforce>true</Enforce>
      <ClientAuthEnabled>true</ClientAuthEnabled>
      <KeyStore>myKeystore</KeyStore>
      <KeyAlias>myKey</KeyAlias>
      <TrustStore>myTruststore</TrustStore>
    </SSLInfo>
  </HttpTargetConnection>
</TargetEndpoint>

Untuk petunjuk mendetail, lihat Opsi untuk mengonfigurasi TLS.

Menggunakan variabel alur untuk menetapkan nilai TLS/SSL secara dinamis

Anda juga dapat menetapkan detail TLS/SSL secara dinamis untuk mendukung persyaratan runtime yang fleksibel. Misalnya, jika proxy terhubung ke dua target yang berpotensi berbeda (target pengujian dan target produksi), Anda dapat membuat proxy API secara terprogram mendeteksi lingkungan yang dipanggilnya dan secara dinamis menetapkan referensi ke keystore dan truststore yang sesuai. Artikel SSLInfo Dinamis untuk TargetEndpoint menggunakan referensi variabel Artikel Komunitas Apigee menjelaskan skenario ini secara lebih mendetail dan memberikan contoh proxy API yang dapat di-deploy.

Pada contoh cara penetapan tag <SSLInfo> di konfigurasi TargetEndpoint berikut, nilai dapat diberikan saat runtime, misalnya, oleh Keterangan Java, kebijakan JavaScript, atau kebijakan MenetapkanMessage. Gunakan variabel pesan mana pun berisi nilai yang ingin Anda tetapkan.

Variabel hanya diizinkan pada elemen berikut.

Catatan: Elemen ini mendukung fitur substitusi string dinamis yang disebut template pesan.

<SSLInfo>
    <Enabled>{myvars.ssl.enabled}</Enabled>
    <ClientAuthEnabled>{myvars.ssl.client.auth.enabled}</ClientAuthEnabled>
    <KeyStore>{myvars.ssl.keystore}</KeyStore>
    <KeyAlias>{myvars.ssl.keyAlias}</KeyAlias>
    <TrustStore>{myvars.ssl.trustStore}</TrustStore>
</SSLInfo>

Catatan: Penggantian variabel nilai TLS/SSL hanya dapat digunakan untuk endpoint target. Upaya apa pun untuk menggunakan variabel dalam konteks lain, seperti logging pesan, akan menyebabkan kegagalan validasi.

Menggunakan referensi untuk menetapkan nilai TLS/SSL secara dinamis

Saat mengonfigurasi endpoint target yang menggunakan HTTPS, Anda harus mempertimbangkan kasus ketika masa berlaku sertifikat TLS/SSL berakhir, atau perubahan pada konfigurasi sistem mengharuskan Anda untuk memperbarui sertifikat.

Untuk informasi selengkapnya, lihat Menangani sertifikat yang sudah tidak berlaku.

Namun, Anda dapat mengonfigurasi endpoint target secara opsional untuk menggunakan referensi ke keystore atau truststore. Keuntungan menggunakan referensi adalah Anda bisa memperbarui referensi agar mengarah ke keystore atau truststore yang berbeda untuk memperbarui sertifikat TLS/SSL tanpa harus memulai ulang Pemroses Pesan.

Catatan: Anda hanya dapat menggunakan referensi ke keystore dan truststore; Anda tidak dapat menggunakan referensi ke alias. Saat mengubah referensi ke keystore, pastikan nama alias sertifikat sama dengan nama alias di keystore lama.

Misalnya, ditunjukkan di bawah ini adalah endpoint target yang menggunakan referensi ke keystore:

<SSLInfo>
  <Enabled>true</Enabled>
  <ClientAuthEnabled>false</ClientAuthEnabled>
  <KeyStore>ref://keystoreref</KeyStore>
  <KeyAlias>myKeyAlias</KeyAlias>
</SSLInfo>

Gunakan panggilan POST API berikut untuk membuat referensi bernama keystoreref:

curl "https://apigee.googleapis.com/v1/organizations/{org}/environments/{org}/references" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -d '<ResourceReference name="keystoreref">
    <Refers>myTestKeystore</Refers>
    <ResourceType>KeyStore</ResourceType>
</ResourceReference>'

Jika $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk mengetahui deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan API Apigee.

Referensi menentukan nama keystore dan jenisnya.

Gunakan panggilan GET API berikut untuk melihat referensi:

curl "https://apigee.googleapis.com/v1/organizations/{org}/environments/{org}/references/keystoreref" \
  -H "Authorization: Bearer $TOKEN"

Jika $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk mengetahui deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan API Apigee.

curl "https://apigee.googleapis.com/v1/organizations/{org}/environments/{org}/references/keystoreref" \
  -H "Authorization: Bearer $TOKEN"

Jika $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk mengetahui deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan API Apigee.

Agar nantinya mengubah referensi agar mengarah ke keystore yang berbeda, memastikan bahwa alias memiliki nama yang sama, gunakan panggilan PUT berikut:

curl "https://apigee.googleapis.com/v1/organizations/{org}/environments/{org}/references/keystoreref" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -d '<ResourceReference name="keystoreref">
    <Refers>myNewKeystore</Refers>
    <ResourceType>KeyStore</ResourceType>
  </ResourceReference>'

Jika $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk mengetahui deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan API Apigee.

TargetEndpoint dengan target load balancing

Endpoint target mendukung load balancing di beberapa server target yang telah diberi nama menggunakan tiga algoritma load balancing.

Untuk petunjuk terperinci, lihat Load balancing di seluruh server backend.

IntegrationEndpoint

IntegrationEndpoint adalah endpoint target yang secara khusus menjalankan integrasi Apigee. Jika Anda telah mengonfigurasi IntegrationEndpoint, Apigee mengirimkan objek request ke Integration Platform Apigee untuk dieksekusi. Untuk menjalankan integrasi, selain mengonfigurasi IntegrationEndpoint, Anda juga harus menambahkan kebijakan SetIntegrationRequest dalam alur proxy.

Anda dapat mengonfigurasi integrasi untuk dijalankan secara sinkron atau asinkron dengan menetapkan elemen <AsyncExecution> dalam konfigurasi IntegrationEndpoint. Untuk mengetahui informasi selengkapnya, lihat Eksekusi sinkron vs. Asinkron. Setelah menjalankan integrasi, Apigee menyimpan respons dalam pesan respons.

Catatan: Anda memerlukan token autentikasi untuk menjalankan IntegrationEndpoint. Namun, tidak ada elemen <Authentication> eksplisit dalam definisi IntegrationEndpoint. Apigee menambahkan token autentikasi ke permintaan di balik layar. Agar IntegrationEndpoint berhasil melakukan autentikasi, Anda harus men-deploy proxy API dengan akun layanan yang memiliki peran IAM yang diperlukan untuk menjalankan integrasi. Untuk mengetahui informasi tentang peran yang diperlukan, lihat Peran IAM untuk integrasi. Untuk mengetahui detail selengkapnya tentang men-deploy proxy API, lihat Men-deploy di Apigee.

Mengonfigurasi IntegrationEndpoint

Untuk mengonfigurasi endpoint integrasi sebagai endpoint target Anda, tambahkan elemen IntegrationEndpoint ke konfigurasi ProxyEndpoint Anda. Berikut adalah contoh konfigurasi ProxyEndpoint:

<ProxyEndpoint name="default">
    <Description/>
    <FaultRules/>
    <PreFlow name="PreFlow">
        <Request>
            <Step>
                <Name>my-set-integration-request-policy</Name>
            </Step>
        </Request>
    </PreFlow>
    <Flows/>
    <PostFlow name="PostFlow"/>
    <HTTPProxyConnection>
        <BasePath>/integration-endpoint-test</BasePath>
        <Properties/>
    </HTTPProxyConnection>
    <RouteRule name="default">
        <IntegrationEndpoint>my-int-endpoint</IntegrationEndpoint>
    </RouteRule>
</ProxyEndpoint>

Dalam contoh konfigurasi ProxyEndpoint, Apigee melakukan tugas berikut:

1. Dalam PreFlow, jalankan kebijakan bernama my-set-integration-request-policy, yang menetapkan objek permintaan integrasi dan variabel alur integrasi.
2. Menggunakan my-int-endpoint sebagai endpoint target, seperti yang ditentukan dalam RouteRule.
3. Membaca objek permintaan integrasi yang dibuat oleh my-set-integration-request-policy.
4. Mengirim permintaan ke Integration Platform Apigee menggunakan objek permintaan dan variabel alur yang ditetapkan oleh kebijakan SetIntegrationRequest.
5. Menyimpan respons integrasi dalam pesan respons.

File XML yang berisi deklarasi <IntegrationEndpoint> akan tersedia di direktori APIGEE_BUNDLE_DIRECTORY/apiproxy/integration-endpoints/. Jika Anda membuat proxy API menggunakan opsi Develop > API Proxies > CREATE NEW > Integration target, Apigee akan menyimpan deklarasi dalam file /apiproxy/integration-endpoints/default.xml. Jika membuat XML endpoint integrasi dari UI, Anda dapat memberikan nama kustom untuk file XML.

Contoh berikut menunjukkan deklarasi elemen <IntegrationEndpoint> dalam file XML:

<IntegrationEndpoint name="my-int-endpoint">
    <AsyncExecution>false</AsyncExecution>
</IntegrationEndpoint>

Elemen konfigurasi IntegrationEndpoint

Name	Deskripsi	Default	Wajib?
IntegrationEndpoint
name	Nama IntegrationEndpoint. Karakter yang dapat Anda gunakan dalam nama dibatasi untuk: A-Za-z0-9._\-$ %	T/A	Ya
AsyncExecution	Nilai Boolean yang menentukan apakah integrasi harus dijalankan dalam mode sinkron atau asinkron. Untuk mengetahui informasi selengkapnya, lihat Eksekusi sinkron vs. Asinkron.	false	Tidak

Eksekusi Sinkron vs Asinkron

Anda dapat mengonfigurasi integrasi untuk berjalan dalam mode sinkron atau asinkron. Untuk memahami perbedaan antara mode eksekusi sinkron dan asinkron, lihat <AsyncExecution>.

Gunakan elemen <AsyncExecution> dalam </IntegrationEndpoint> untuk menentukan eksekusi sinkron atau asinkron. Jika Anda menetapkan <AsyncExecution> ke true, integrasi akan berjalan secara asinkron. Selain itu, jika Anda menetapkannya ke false, integrasi akan berjalan secara sinkron.

Contoh berikut menetapkan AsyncExecution ke true:

<IntegrationEndpoint name="my-int-endpoint">
    <AsyncExecution>true</AsyncExecution>
</IntegrationEndpoint>

Kebijakan

Direktori /policies di proxy API berisi semua kebijakan yang tersedia untuk dilampirkan ke Flow di proxy API.

Elemen konfigurasi kebijakan

Name	Deskripsi	Default	Wajib?
Policy
name	Nama internal kebijakan. Karakter yang dapat Anda gunakan dalam nama dibatasi untuk: A-Za-z0-9._\-$ %. Namun, UI Apigee menerapkan pembatasan tambahan, seperti otomatis menghapus karakter yang bukan alfanumerik. Opsional, gunakan elemen <DisplayName> untuk memberi label kebijakan di editor proxy UI Apigee dengan nama bahasa alami yang berbeda.	T/A	Ya
enabled	Setel ke true untuk menerapkan kebijakan. Setel ke false untuk menonaktifkan kebijakan. Kebijakan ini tidak akan diterapkan meskipun tetap disertakan ke alur.	true	Tidak
continueOnError	Tetapkan ke false untuk menampilkan error saat kebijakan gagal. Ini adalah perilaku yang diharapkan untuk sebagian besar kebijakan. Tetapkan ke true agar eksekusi alur dapat dilanjutkan bahkan setelah kebijakan gagal.	false	Tidak
async	Catatan: Atribut ini tidak membuat kebijakan dieksekusi secara asinkron. Biasanya, gunakan nilai default false. Jika disetel ke true, eksekusi kebijakan akan dialihkan ke thread lain, sehingga thread utama bebas menangani permintaan tambahan. Saat pemrosesan offline selesai, thread utama akan kembali dan selesai menangani alur pesan. Dalam beberapa kasus, menetapkan asinkron ke true akan meningkatkan performa proxy API. Namun, penggunaan asinkron yang berlebihan dapat mengganggu performa dengan terlalu banyak pengalihan thread. Untuk menggunakan perilaku asinkron di proxy API, lihat model objek JavaScript.	false	Tidak

Lampiran kebijakan

Gambar berikut menunjukkan urutan eksekusi alur proxy API:

Seperti yang ditunjukkan di atas:

Kebijakan dilampirkan sebagai langkah pemrosesan ke Flow. Nama kebijakan digunakan untuk mereferensikan kebijakan yang akan diterapkan sebagai Langkah pemrosesan. Format lampiran kebijakan adalah sebagai berikut:

<Step><Name>MyPolicy</Name></Step>

Kebijakan ditegakkan sesuai urutan penerapannya ke Flow. Contoh:

<Step><Name>FirstPolicy</Name></Step>
<Step><Name>SecondPolicy</Name></Step>

Elemen konfigurasi lampiran kebijakan

Name	Deskripsi	Default	Wajib?
Step
Name	Nama kebijakan yang akan dijalankan oleh definisi Langkah ini.	T/A	Ya
Condition	Pernyataan kondisional yang menentukan apakah kebijakan diterapkan atau tidak. Jika kebijakan memiliki kondisi terkait, kebijakan hanya akan dijalankan jika pernyataan bersyarat bernilai benar (true).	T/A	Tidak

Alur

ProxyEndpoint dan TargetEndpoint menentukan pipeline untuk pemrosesan pesan permintaan dan respons. Pipeline pemrosesan terdiri dari alur permintaan dan alur respons. Setiap alur permintaan dan alur respons dibagi lagi menjadi PreFlow, satu atau beberapa alur conditional atau conditional opsional, dan PostFlow.

• PreFlow: Selalu dijalankan. Dijalankan sebelum Flow kondisional.
• PostFlow: Selalu dijalankan. Dieksekusi setelah Flow kondisional.

Selain itu, Anda dapat menambahkan PostClientFlow ke endpoint proxy, yang dijalankan setelah respons ditampilkan ke aplikasi klien yang meminta. Hanya kebijakan MessageLogging yang dapat disertakan ke alur ini. PostClientFlow mengurangi latensi proxy API dan menyediakan informasi untuk logging yang tidak dihitung hingga setelah respons dikembalikan ke klien, misalnya client.sent.start.timestamp dan client.sent.end.timestamp.Alur ini terutama digunakan untuk mengukur interval waktu antara stempel waktu awal dan akhir untuk pesan respons.

Berikut adalah contoh PostClientFlow dengan kebijakan logging pesan terlampir.

...
  <PostFlow name="PostFlow">
      <Request/>
      <Response/>
  </PostFlow>
  <PostClientFlow>
      <Request/>
      <Response>
          <Step>
              <Name>Message-Logging-1</Name>
          </Step>
      </Response>
  </PostClientFlow>
  ...

Pipeline pemrosesan proxy API mengeksekusi Flow dalam urutan berikut:

Pipeline Permintaan:

1. PreFlow Permintaan Proxy
2. Alur Bersyarat Permintaan Proxy (Opsional)
3. PostFlow Permintaan Proxy
4. PreFlow Permintaan Target
5. Alur Bersyarat Permintaan Target (Opsional)
6. PostFlow Permintaan Target

Pipeline Respons:

1. PreFlow Respons Target
2. Alur Bersyarat Respons Target (Opsional)
3. PostFlow Respons Target
4. PreFlow Respons Proxy
5. Alur Bersyarat Respons Proxy (Opsional)
6. PostFlow Respons Proxy
7. Respons PostClientFlow (Opsional)

Hanya Flow dengan lampiran kebijakan yang perlu dikonfigurasi di konfigurasi ProxyEndpoint atau TargetEndpoint. PreFlow dan PostFlow hanya perlu ditentukan dalam konfigurasi ProxyEndpoint atau TargetEndpoint ketika kebijakan perlu diterapkan selama pemrosesan PreFlow atau PostFlow.

Berbeda dengan alur bersyarat, urutan elemen PreFlow dan PostFlow tidak penting; proxy API akan selalu mengeksekusi masing-masing pada titik yang sesuai dalam pipeline, terlepas dari tempat elemen tersebut muncul dalam konfigurasi Endpoint.

Alur bersyarat

Endpoint proxy dan endpoint target mendukung alur bersyarat dalam jumlah yang tidak terbatas (juga dikenal sebagai alur bernama).

Proxy API menguji kondisi yang ditetapkan dalam alur bersyarat dan, jika kondisi tersebut terpenuhi, langkah-langkah pemrosesan dalam alur bersyarat akan dijalankan oleh proxy API. Jika kondisi ini tidak terpenuhi, langkah-langkah pemrosesan dalam alur bersyarat akan diabaikan. Alur bersyarat dievaluasi dalam urutan yang ditentukan di proxy API dan alur pertama yang kondisinya terpenuhi akan dijalankan.

Dengan menentukan alur bersyarat, Anda dapat menerapkan langkah-langkah pemrosesan dalam proxy API berdasarkan:

• URI Permintaan
• Kata kerja HTTP (GET/PUT/POST/DELETE)
• Nilai parameter kueri, header, dan parameter formulir
• Banyak jenis kondisi lainnya

Misalnya, alur bersyarat berikut menentukan bahwa kode tersebut hanya dijalankan jika jalur resource permintaan adalah /accesstoken. Setiap permintaan masuk dengan jalur /accesstoken akan menyebabkan flow ini dijalankan, beserta kebijakan apa pun yang disertakan ke flow. Jika jalur permintaan tidak menyertakan akhiran /accesstoken, alur tidak akan dijalankan (meskipun alur bersyarat lainnya mungkin).

<Flows>
  <Flow name="TokenEndpoint">
    <Condition>proxy.pathsuffix MatchesPath "/accesstoken"</Condition>
    <Request>
      <Step>
        <Name>GenerateAccessToken</Name>
      </Step>
    </Request> 
  </Flow>
</Flows>   

Elemen konfigurasi flow

Name	Deskripsi	Default	Wajib?
Flow	Pipeline pemrosesan permintaan atau respons yang ditentukan oleh endpoint proxy atau endpoint target
Name	Nama unik Flow.	T/A	Ya
Condition	Pernyataan kondisional yang mengevaluasi atau beberapa variabel untuk dievaluasi menjadi benar atau salah. Semua Flow selain jenis PreFlow dan PostFlow yang telah ditetapkan harus menentukan kondisi eksekusinya.	T/A	Ya
Request	Pipeline yang terkait dengan pemrosesan pesan Request	T/A	Tidak
Response	Pipeline yang terkait dengan pemrosesan pesan Response	T/A	Tidak

Pemrosesan langkah

Urutan Flow kondisional secara berurutan diterapkan oleh Apigee. Aliran Bersyarat dieksekusi dari atas ke bawah. Flow kondisional pertama yang kondisinya bernilai true akan dieksekusi, dan hanya satu Flow bersyarat yang dijalankan.

Misalnya, dalam konfigurasi Flow berikut, setiap permintaan masuk yang tidak menyertakan akhiran jalur /first atau /second akan menyebabkan ThirdFlow dijalankan, yang menerapkan kebijakan yang disebut Return404.

<Flows>
  <Flow name="FirstFlow">
    <Condition>proxy.pathsuffix MatchesPath "/first"</Condition>
    <Request>
      <Step><Name>FirstPolicy</Name></Step>
    </Request>
  </Flow>
  <Flow name="SecondFlow">
    <Condition>proxy.pathsuffix MatchesPath "/second"</Condition>
    <Request>
      <Step><Name>FirstPolicy</Name></Step>
      <Step><Name>SecondPolicy</Name></Step>
    </Request>
  </Flow>
  <Flow name="ThirdFlow">
    <Request>
      <Step><Name>Return404</Name></Step>
    </Request>
  </Flow>
</Flows>

Referensi

"Resource" (file resource untuk digunakan dalam proxy API) adalah skrip, kode, dan transformasi XSL yang dapat disertakan ke Flow menggunakan kebijakan. Skrip ini muncul di bagian Skrip pada editor proxy API di UI Apigee.

Lihat Mengelola resource untuk jenis resource yang didukung.

Resource dapat disimpan di proxy API, lingkungan, atau organisasi. Dalam setiap kasus, resource dirujuk berdasarkan nama dalam Kebijakan. Apigee me-resolve nama dengan berpindah dari proxy API, ke lingkungan, ke level organisasi.

Resource yang disimpan di tingkat organisasi dapat dirujuk oleh Kebijakan di lingkungan apa pun. Resource yang disimpan pada tingkat lingkungan dapat direferensikan oleh Kebijakan di lingkungan tersebut. Resource yang disimpan di level proxy API hanya dapat direferensikan oleh Kebijakan di proxy API tersebut.