Menyiapkan dan mengonfigurasi Edge Microgateway

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

Edge Microgateway v. 2.3.x

Ringkasan

Tutorial ini memandu Anda melalui langkah-langkah yang diperlukan untuk meningkatkan instance Edge Microgateway dan berjalan.

Setelah menyelesaikan langkah-langkah di sini, Anda akan memiliki Edge Microgateway yang dikonfigurasi sepenuhnya dan berfungsi yang mampu memproses permintaan API. Anda akan menguji penyiapan dengan melakukan panggilan API yang aman melalui Edge Microgateway ke target backend. Anda juga akan mempelajari cara menambahkan penahanan lonjakan plugin ke Microgateway.

Panduan ini dibagi menjadi bagian-bagian berikut:

Prasyarat: Instal Edge Microgateway

Ikuti petunjuk di Menginstal Edge Microgateway. Setelah menyelesaikan instalasi, Anda akan siap untuk mengikuti langkah-langkah dalam tutorial.

Setelah selesai melakukan penginstalan, lanjutkan ke bagian berikutnya, "Bagian 1: Configure Edge Microgateway".

Bagian 1: Mengonfigurasi Edge Microgateway

Di bagian ini, Anda akan menggunakan perintah antarmuka command line (CLI) untuk mengonfigurasi Edge Microgateway untuk berkomunikasi dengan Apigee Edge. Jika Anda menggunakan Apigee Edge Cloud, ikuti langkah-langkah konfigurasi Apigee Edge Cloud. Jika Anda berada di Apigee Private Cloud, ikuti langkah-langkah untuk Apigee Edge Private Google Cloud.

Langkah-langkah konfigurasi Apigee Edge Cloud

Ikuti langkah-langkah berikut untuk menggunakan Edge Microgateway dengan Apigee Edge Cloud:

  1. Jika Anda belum melakukannya sebelumnya, inisialisasi Edge Microgateway (Anda hanya perlu melakukannya langkah satu kali):
    edgemicro init
  2. (Opsional) Bantuan cetak untuk perintah edgemicro configurations:
    edgemicro configure -h
  3. Jalankan perintah berikut untuk mengonfigurasi Edge Microgateway:
    edgemicro configure -o [org] -e [env] -u [username] 

    Dengan keterangan:

    • org adalah nama organisasi Edge Anda (Anda harus merupakan administrator org).
    • env adalah lingkungan di organisasi Anda (seperti pengujian atau prod).
    • username adalah alamat email yang terkait dengan Akun Apigee.

Contoh

edgemicro configure -o docs -e test -u jdoe@example.com

Output

./edgemicro configure -o docs -e test -u jdoe@apigee.com
password:
current nodejs version is v6.1.0
current edgemicro version is 2.2.3-beta
password:
file doesn't exist, setting up
Give me a minute or two... this can take a while...
App edgemicro-auth deployed.
creating vault
adding private_key
adding public_key
configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1

saving configuration information to: /Home/.edgemicro/wwitman-test-config.yaml

vault info:
 -----BEGIN CERTIFICATE-----
MIICpDCCAYwCCQCaDpaTttaDANBgkqhkiG9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3QwHhcNMTYxAxMjA0NzIyWhcNMTYxMTAyMjA0NzIyWjAUMRIwEAYD
VQQDEwlsb2NhbGhvcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDA
YbtbsFe50GgBrI8QTih5yzxxxvCfdubGrLWmovwwCCFthno3u8lS54ekOL9jQu
JTJsocJfNhZxvnXifDsCk5Muwx87Z/D0BYLw9ZhM8TMyA2MCkXgC6RfKT69IdJ
jT3X+3D0s+apr3lACsDhgOfaeQfeHAm1SSwH/VemaJqdImGkQMtM8uscMDwG6k
vBbCSNS+hh6ZH1m3tAkcKXqvj/E1hbrHNTWr+uiYFRByUzeo1I607daQD4Lxid
il4Ng3hr3LC1gEzvobWgVyhQ2ovYB57T886H7dGghTnOUxLm2y/TwmQya+44SL
JSsDwauArMF38cRKZZ7VAgMBAAEwDQYJKoZIhvcNAQELBQADEBAHwwu+gOn8Tq
jKOYBTXtOX11HPMTxmyvZ/I57R4roE7Z/lXg/DXwbiFpFG2uamXNKq7yTDJH2i
iiqdERZOGfv7TJMjRlxEnfVHoCV7UKguKq4zeeAEU2x55yFwpWNrarx0kMXRwI
v3WgGfo2bimFQrCjDCNIkDKmYYt4SXIF5zUJmBWPCaK9aJoQb7ARXQO9s2zoOI
XZ5bCUDbehQZ+6LyqC0hgDXiIZYy7R0j93yCbQgoHaHUMEprJEEjE24SHdsWBO
nxGZxB20JLq5AHTm8lbZp7XtvbU0jVpxyrBo2/olFnmpvBVOq9eIp042IVD7nT
J4rPejdK6C4=
-----END CERTIFICATE-----

The following credentials are required to start edge micro
  key: e88ec9d5da17cd88ca338d532b7c7a8c4f43ddd3da139d95955ab345af30352d
  secret: d7f64854eb6889d06b809dd7c161dba5eeba4a2657277fd819921bf992221a8f

edgemicro configuration complete!
    

Langkah-langkah konfigurasi Apigee Private Cloud

Ikuti langkah-langkah berikut untuk menggunakan Edge Microgateway dengan Apigee Private Cloud:

  1. Mencetak informasi bantuan untuk edgemicro private konfigurasikan aplikasi Anda. Anda dapat mencetak bantuan dengan cara ini untuk Edge Microgateway CLI apa pun perintah atau opsi perintah.
    edgemicro private configure -h
  2. Jalankan perintah berikut. Memerlukan informasi standar tentang Apigee Edge Anda Akun Private Cloud: nama organisasi, nama lingkungan, nama pengguna (alamat email), sandi, manajemen IP dan IP {i>router<i}. Anda harus menjadi administrator organisasi Edge untuk menggunakan fitur ini berikut:
    edgemicro private configure -o [org] -e [env] -u [username] -r [runtime_url] -m [mgmt_url] -v [virtual_host]

    Dengan keterangan:

    • org adalah nama organisasi Edge Anda (Anda harus merupakan administrator org).
    • env adalah lingkungan di organisasi Anda (seperti pengujian atau prod).
    • runtime_url adalah URL runtime untuk pribadi Anda di instance Cloud.
    • mgmt_url adalah URL server pengelolaan untuk ke instance cloud pribadi Anda.
    • username adalah alamat email yang terkait dengan Akun Apigee.
    • virtual_host adalah daftar host virtual yang dipisahkan koma nama. Nilai defaultnya adalah default,secure

Contoh

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.52.106:9001 -m http://192.162.52.106:8080 -v default

atau, jika Anda memiliki alias virtual host myorg-test.mycompany.com, Anda akan gunakan perintah seperti ini:

edgemicro private configure -o docs -e test -u jdoe@example.com -r myorg-test.mycompany.com -m http://192.162.52.106:8080 -v default

Output

delete cache config
checking for previously deployed proxies
configuring edgemicro internal proxy
deploying edgemicro internal proxy
deploying  edgemicro-auth  app
copy auth app into tmp dir
copy config into tmp deer
Give me a minute or two... this can take a while...
App edgemicro-auth added to your org. Now adding resources.

checking org for existing vault creating vault adding private_key adding public_key
configuring host http://192.168.52.106:9001 for region dc-1

saving configuration information to: /Users/ApigeeCorporation/.edgemicro/jdoe-test-config.yaml 
vault info: 
-----BEGIN CERTIFICATE----- 
MIICpDCCAYwCCQDpIvWlpaZJGDANBgkqhkiG9w0BAQFADAUMRIwEAYDVQQDEwls 
b2NhbGhvc3QwHhcNMTYwNDA3MTcxNTM5WhcNMTYwND4MTcxNTM5WjAUMRIwEAYD 
VQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAUAA4IBDwAwggEKAoIBAQD3 
OAQ+kf5FH0S0yuj05ITqUODuUJspBPberRMbqOZYHcFswhB0Yvg6JKWxKWBDP9o 
Xl96dtgH7xPFRqIU0zI452jkMQ1fPz2mSaGwik245yfBku7olooXKRKTRKOUoXa 
q3Hld/RPxGSsWtiyyYtKex7tuFdq0Knm1EhowdTRGIgjNvudeYMka/XPRXuykhd 
xIDxWj4rdX+4GPx9qT2eTQC5nOAC7XHVL7ys4KqsAiv28vw10u400KstFFS8Qho 
7FaE0bOKLolKKadKyA60ha1XIw/uSTD6ZQFWQ+XM3OaRbXePWXnSZioSxXcZT7L 
hMUKbsRXw/TCvRB51LgNAgMBAAEwDQYJKoZIhvcNAQELBQADgEBAOuR1OmE/W6j 
gRAarJB5EQuTEpI/9Zpg5c5RAGjzLhkazsycn7pal+IymUjCV7D0oIxTVuTM8ZZ 
57kR5hF/C1ZypDN9i+KGP2ovX8WOCCXYtIQECgZPB/L/7/k7BDuKN4vFBvWUe3X 
s2oyjnVWy+ASqsW8gHfj8ekhe22bP240Oqkbyg9SZP9ol1tvJX6+M0thYwcTwAd 
ft929Icey/MOTQC0jB2qm0gnIx/7KInFXfS5KoFRJoGrWDeckr3RdBo2LhnPaeZ 
1gPYIqphZ3HfisF5KlBXoR8oT/Ilym/nq5COlv+3L4tMIk18F7BQZB60SRazifz 
pFkIxepyr/0= 
-----END CERTIFICATE----- 

The following credentials are required to start edge micro 
   key: a3f8f3dfe39158fc3c50b274f0af2234246e0d5f6ea4dd09389b645147151ba3 
   secret: 3e9904802fb3c0e8ca408128a11119cf13546d54dac30ace944c097a726a1263

edgemicro configuration complete!
    

Memverifikasi penginstalan

Jalankan perintah ini untuk memverifikasi penginstalan. Jika tidak ada error yang dilaporkan, artinya semuanya sudah disiapkan dengan benar dan Anda akan berhasil memulai Edge Microgateway.

edgemicro verify -o [org] -e [env] -k [key] -s [secret]

Dengan keterangan:

  • org adalah nama organisasi Edge Anda (Anda harus merupakan organisasi administrator).
  • env adalah lingkungan di organisasi Anda (seperti pengujian atau prod).
  • key adalah kunci yang ditampilkan sebelumnya oleh konfigurasi perintah.
  • secret adalah kunci yang ditampilkan sebelumnya oleh konfigurasi perintah.

Contoh

edgemicro verify -o docs -e test -k 93b01fd21d86331459ae52f664ae9aeb13eb94767ce40a4f621d172cdfb7e8e6 -s c8c755be97cf56c21f8b0556d7132afbd03625bbd85dc34ebfefae4f23fbcb3c

Tentang konfigurasi

Semua konfigurasi yang telah dilakukan sejauh ini memungkinkan Edge Microgateway untuk mem-bootstrap dirinya sendiri ke Apigee Edge. Setelah bootstrap berhasil, Edge Microgateway mengambil payload informasi konfigurasi dari Apigee Edge.

Untuk apa informasi konfigurasi ini digunakan? Seperti yang akan kita temukan di bagian selanjutnya dari ini, saat Edge Microgateway dimulai, Edge Microgateway perlu menerima daftar Proxy API berbasis Microgateway dari Apigee Edge. Di bagian selanjutnya dari tutorial ini, Anda akan membuat Microgateway-aware proxy. Edge Microgateway membatasi klien untuk hanya memanggil API ditangani oleh proxy API yang mendukung Microgateway ini, dan klien akan diminta (secara default) untuk menunjukkan token keamanan yang valid untuk setiap panggilan. Untuk membaca selengkapnya tentang {i>proxy<i} ini, lihat "Apa yang perlu mengetahui tentang proxy berbasis Edge Microgateway di Ringkasan Edge Microgateway.

Sebagai admin org Edge, Anda mungkin tertarik untuk mengetahui bahwa proxy yang peka Microgateway Edge dapat ditambahkan ke produk Edge, sama seperti proxy lainnya. Melalui penggunaan produk dan developer Anda bisa membuat token keamanan spesifik per klien untuk mengontrol akses ke API yang dipanggil melalui Edge Microgateway. Sekali lagi, pola yang terlibat identik dengan bekerja dengan {i>proxy<i} API apa pun, produk, dan aplikasi developer di Apigee Edge. Jika Anda ingin membaca informasi tentang produk, mulailah dengan Apa yang dimaksud dengan produk API? di Edge dokumentasi tambahan.

Selanjutnya kita akan membahas cara membuat {i>proxy<i} yang berbasis {i>Microgateway<i}, dan setelah itu, kita akan mulai Edge Microgateway dan uji penyiapan.

Bagian 2: Membuat entity di Apigee Edge

Di bagian ini, Anda akan membuat entity ini di Edge:

  • A microgateway-aware proxy - Layanan ini adalah yang dapat ditemukan Edge Microgateway saat startup. {i>Proxy<i} sadar {i>microgateway<i} memiliki konvensi penamaan yang harus Anda ikuti: nama harus dengan edgemicro_. Sebagai contoh edgemicro_hello atau edgemicro_userinfo. Saat Edge Microgateway dimulai, Edge mengambil daftar proxy yang mendukung microgateway dari Edge organisasi dan lingkungan Edge yang sama dengan yang Anda tentukan saat memulai Edge Microgateway.

    Untuk setiap {i>microgateway-aware proxy<i}, Edge Microgatway mengambil URL target dari proxy dan jalur dasarnya. Proxy berbasis Microgateway juga menyediakan cara yang mudah untuk mengaitkan analisis data yang dihasilkan oleh Edge Microgateway dengan proxy di platform Edge. Sebagai Microgateway menangani panggilan API, model ini akan mengirim data analisis ke Edge secara asinkron. Data Analytics akan muncul di UI Edge Analytics di bawah nama proxy berbasis microgateway, seperti halnya untuk {i>proxy<i}.
  • Produk, developer, dan aplikasi developer - Edge Microgateway menggunakan produk, developer, dan aplikasi developer untuk mengaktifkan keamanan kunci API atau token akses OAuth2. Saat dimulai, Edge Microgateway akan mendownload semua konfigurasi produk dari Apigee Pengaturan Edge. Informasi ini digunakan untuk memverifikasi panggilan API yang dilakukan melalui Edge Microgateway dengan kunci API atau token akses OAuth2.

Baca selengkapnya: Lihat juga "Yang perlu Anda ketahui tentang Edge Microgateway-aware proxy" di Overview of Edge Microgateway.

1. Berkreasi proxy API berbasis Edge Microgateway di Edge

  1. Login ke organisasi Anda di Apigee Edge.
  2. Klik SWITCH TO CLASSIC untuk membuka UI Edge Classic.
  3. Pilih API > Proxy API dari menu atas.
  4. Di halaman API Proxy, klik + API Proxy.
  5. Di wizard Build a Proxy, pilih Reverse proxy (paling umum).
  6. Klik Berikutnya.
  7. Di halaman Detail wizard, konfigurasikan sebagai berikut. Pastikan untuk mengisi wizard persis seperti yang ditampilkan:
    • Nama Proxy: edgemicro_hello
    • Jalur Dasar Proxy: /hello
    • API yang sudah ada: http://mocktarget.apigee.net/
  8. Klik Berikutnya.
  9. Di halaman Security di wizard, pilih Pass through (none).
  10. Klik Berikutnya.
  11. Pada halaman Host Virtual wizard, terima setelan default.
  12. Klik Berikutnya.
  13. Pada halaman Build di wizard, tinjau setelan proxy Anda. Pastikan lingkungan test dipilih.
  14. Klik Build and Deploy.

2. Membuat produk

Buat produk yang berisi dua proxy:

  • Proxy berbasis microgateway Anda: edgemicro_hello
  • Proxy autentikasi yang diinstal oleh Edge Microgateway: edgemicro-auth.
  1. Di UI Edge (Versi klasik), buka Publikasikan > Produk.
  2. Di halaman Produk, klik + Produk. Lengkapi Detail Produk halaman sebagai berikut:
    • Nama: EdgeMicroTestProduct
    • Nama Tampilan: EdgeMicroTestProduct
    • Lingkungan: pengujian dan produksi
    • Akses: Publik
    • Jenis Persetujuan Kunci: Otomatis
    • Materi:
      • Proxy API: Pilih edgemicro_hello
      • Revisi: 1
      • Jalur Resource: /**
  3. Klik Import Resource.
  4. Di Resources, klik +API Proxy
  5. Pilih edgemicro-auth
  6. Klik Simpan.

3. (Opsional) Buat developer uji

Untuk tujuan tutorial ini, Anda dapat menggunakan pengembang yang ada untuk langkah berikutnya, membuat aplikasi pengembang. Namun, jika Anda mau, Anda dapat membuat developer pengujian sekarang:

  1. Buka Publikasikan > Developer.
  2. Di halaman Produk, klik + Developer.
  3. Isi dialog untuk membuat developer pengujian.

4. Membuat aplikasi developer

Anda akan menggunakan kredensial klien dari aplikasi ini untuk melakukan panggilan API aman melalui Microgateway Edge:

  1. Buka Publikasikan > Aplikasi Developer.
  2. Di halaman Aplikasi Developer, klik + Aplikasi Developer.
  3. Isi halaman Aplikasi Developer sebagai berikut:
    1. Nama: EdgeMicroTestApp
    2. Nama Tampilan: EdgeMicroTestApp
    3. Developer: Jika Anda membuat developer pengujian, pilih developer tersebut. Atau, Anda dapat menggunakan developer yang ada untuk tujuan tutorial ini.
    4. Kredensial:
      1. Pilih Akhir Masa Berlaku: Tidak pernah.
      2. Klik + Produk dan pilih EdgeMicroTestProduct (produk yang baru saja Anda dibuat)
  4. Klik Simpan.
  5. Anda akan kembali ke halaman daftar Aplikasi Developer.
  6. Pilih aplikasi yang baru saja Anda buat, EdgeMicroTestApp.
  7. Klik Show di samping Consumer Kunci dan Rahasia Konsumen.

Bagian 3: Mengoperasikan Edge Microgateway

Setelah Anda memiliki Edge Microgateway yang dikonfigurasi dan setidaknya satu Edge Microgateway-aware di Edge, saatnya memulai Edge Microgateway. Server HTTP Edge Microgateway akan berjalan di komputer lokal Anda, dan Anda akan melakukan panggilan API langsung ke server tersebut.

1. Mulai Edge Microgateway

Gunakan perintah edgemicro start untuk memulai Edge Microgateway.

  1. Pastikan Anda memiliki kunci yang dikembalikan sebelumnya saat Anda menjalankan perintah edgemicro konfigurasi. Output itu terlihat seperti ini:
    You need key and secret while starting edgemicro instance
    
    key: da4778e7c240a5d4585fc559eaba5083328828ac9f3a7f583e8b73e
    secret: 3aad7439708b4aeb38ee08e87189921ad00e6fc1ba8a8ae9f929ee2
  2. (Opsional) Cetak informasi bantuan untuk perintah edgemicro start.
    edgemicro start -h
  3. Untuk memulai Edge Microgateway, jalankan perintah berikut:
    edgemicro start -o [org] -e [env] -k [key] -s [secret]

    Dengan keterangan:

    • org adalah nama organisasi Edge Anda (Anda harus merupakan administrator org).
    • env adalah lingkungan di organisasi Anda (seperti pengujian atau prod).
    • key adalah kunci yang ditampilkan sebelumnya oleh konfigurasi perintah.
    • secret adalah kunci yang ditampilkan sebelumnya oleh perintah config.

    Contoh

    edgemicro start -o docs -e test -k 701e70e718ce6dc1880616b3c39177d64a88754d615c7a4e1f78b6181d000723 -s 05c14356e42d136b83dd135cf8a18531ff52d7299134677e30ef4e34ab0cc824

    Output

    Perintah start mengambil banyak informasi konfigurasi dari Apigee Edge (yang akan men-scroll ke jendela terminal). Di output, Anda akan melihat daftar antarmuka berbasis microgateway {i>proxy<i} dan produk yang ditemukan. Di akhir output, Anda akan melihat sesuatu seperti ini:

    ...
    
    PROCESS PID : 9757
    installed plugin from analytics
    installed plugin from oauth
    eb725020-a2b0-11e6-8a52-6de156e3a6e2 edge micro listening on port 8000
    installed plugin from analytics
    installed plugin from oauth
    installed plugin from analytics
    installed plugin from oauth
    installed plugin from analytics
    installed plugin from oauth
    eb77ce60-a2b0-11e6-8a88-b96278c0c198 edge micro listening on port 8000
    eb78b8c0-a2b0-11e6-bf36-717b986c91fe edge micro listening on port 8000
    eb77f570-a2b0-11e6-883e-472b9104351e edge micro listening on port 8000

Apa yang terjadi?

Lihat terminal tempat Anda menjalankan perintah edgemicro config. Menelusuri {i>output<i} standar, Anda bisa melihat bahwa perintah itu mengambil {i>payload<i} dari Informasi konfigurasi Edge Microgateway dari Apigee Edge. Informasi ini mencakup:

  • Kunci publik yang kita buat dan simpan sebelumnya di vault Apigee.
  • Representasi JSON dari semua proxy berbasis Edge Microgateway yang ada di organisasi/lingkungan Anda. Ini semua adalah {i>proxy<i} yang dinamai dengan tambahkan awalan edgemicro_.
  • Representasi JSON dari semua produk API yang ada di organisasi/lingkungan Anda.

Dengan informasi ini, Edge Microgateway mengetahui proxy dan jalur proxy mana yang diizinkan {i>checkout<i}. Proses ini menggunakan informasi produk untuk menegakkan keamanan (dengan cara yang sama persis dengan API apa pun dilakukan di Apigee Edge, tempat kunci aplikasi developer memiliki hubungan dengan produk). Mari kita lanjutkan melalui langkah-langkah untuk segera mengamankan Edge Microgateway.

2. Menguji Microgateway Edge

Saat Edge Microgateway berjalan, Anda dapat memanggil proxy. Konfigurasi untuk proxy edgemicro_hello didownload dari Edge saat Anda memulai Edge Microgateway. Ingat, jalur basis proxy adalah /hello.

Untuk menguji Edge Microgateway, kita mulai dengan jalur dasar dan menambahkan resource jalur /echo. Perhatikan bahwa semua yang ditulis setelah jalur dasar (termasuk semua kueri ) akan diteruskan ke target backend:

curl -i http://localhost:8000/hello/echo
{"error":"missing_authorization","error_description":"Missing Authorization header"}

Error terjadi karena Anda tidak mengirim kunci API atau token akses yang valid bersama permintaan. Menurut secara default, Edge Microgateway memerlukan kunci API atau token akses di setiap panggilan API. Di beberapa langkah tutorial berikutnya, kami akan mengamankan API ini dengan benar dan menunjukkan cara token akses dan menyertakannya dengan permintaan.

4. Hentikan Microgateway Edge

  1. Di jendela terminal terpisah, cd ke alamat yang sama tempat Anda memulai Edge Microgateway.
  2. Masukkan perintah berhenti:
    edgemicro stop

Bagian 4: Secure Edge Microgateway

Anda bisa mengamankan panggilan API yang dilakukan melalui Edge Microgateway menggunakan kunci API atau sebelumnya yang benar.

Panggilan API aman dengan token akses OAuth2

Ikuti langkah-langkah berikut jika Anda ingin mengautentikasi panggilan API dengan token akses OAuth2:

1. Mendapatkan kunci yang diperlukan

  1. Di UI Edge, buka Aplikasi Developer yang Anda buat sebelumnya, seperti yang dijelaskan di Bagian 2: Membuat entity di Apigee Edge. Nama Aplikasi ini EdgeMicroTestApp.
  2. Di halaman Aplikasi Developer, tampilkan Kunci Konsumen dan Rahasia Konsumen, lalu salin mereka. Nilai ini diperlukan untuk mendapatkan token akses dalam waktu.

2. Mendapatkan token akses

Ada dua cara untuk memperoleh token akses. Kami akan menunjukkan kedua metode tersebut.

Menggunakan CLI untuk mendapatkan token akses

Metode pertama mudah, dan mengikuti pola yang telah kita gunakan di sepanjang tutorial ini. Metode kedua umumnya lebih berguna bagi developer aplikasi klien yang perlu meminta token. Endpoint token aktual diimplementasikan di proxy edgemicro-auth yang diterapkan saat Anda mengonfigurasi Edge Microgateway.

  1. (Opsional) Lihat bantuan untuk perintah token get:
    edgemicro token get -h
  2. Buat token, dengan mengganti nilai Kunci Konsumen dan Rahasia Konsumen dari aplikasi developer yang Anda buat di Apigee Edge pada parameter -i dan -s:
    edgemicro token get -o [org] -e [env] -i [consumer_key] -s [consumer_secret]

    Dengan keterangan:

    • org adalah nama organisasi Edge Anda (Anda harus merupakan administrator org).
    • env adalah lingkungan di organisasi Anda (seperti pengujian atau prod).
    • consumer_id adalah ID Konsumen di Aplikasi Developer yang telah Anda buat sebelumnya.
    • consumer_secret adalah Rahasia Konsumen di Aplikasi Developer yang Anda buat sebelumnya.

    Contoh

    edgemicro token get -o docs -e test -i G0IAeU864EtBo99NvUbn6Z4CBwVcS2 -s uzHTbwNWvoSmOy

    Output (Contoh)

    current nodejs version is v4.4.4
    { token: 'eyJ0eXAiOiJKV1QiLCJhbGciSUzI1NiJ9.eyJhcHBsaWNhdGl
    vbl9uYW1lIjoiNWNiMGY0tOWMzOC00YmJjLWIzNzEtZGMxZTQzOGYxZGMxI
    iwiY2xpZW50X2lkIjoiNVVdBWEdvSU9lbzYwYWV3OTRQN0c1TUFaRTNhSnA
    iLCJzY29wZXMiOltdLCJhcGlfcHJvjdF9saXN0IjpbIkVkZ2VNaWNyb1Rlc
    3RQcm9kdWN0IlmlhdCI6MTQ3ODIwODMzMiwiZXhwIjoxNDc4MjEwMTMxfQ.
    v3Q8Rs0W9FO_XpERwIAMMXhjGamRmmmWgrAy1wJv0-99oajx5ASI5qjNubM
    nCF14xxwlVXHcz1VfedA8Nx7Ih145zhWWuPKL9muzhXXnVBRFeBMeeLqJk4
    QQ7Bhst7xH_68nJSTE20Egu95DHOCUemfrepDFH0VggY4BmzvwLkBNfz_te
    E_YqwKZbpGOLMdKK1vMk0fk0x19SieIMS_aJYeOAklrzUhnFxWJFrsAWsax
    NLx_BbQcZzYfK1JSDUrhRNVBuPHMnGjNA_oHw2J4qa6Hsp62PfchG-DIW_t
    -0BFnYf3rYXmqyNORqFrOMdl4VxqQ' }

(Opsional) Menggunakan API untuk mendapatkan token

Jika Anda terbiasa memanggil proxy Edge menggunakan curl atau klien HTTP lainnya, Anda akan tertarik mengetahui bahwa Anda dapat memanggil endpoint token secara langsung, daripada menggunakan perintah edgemicro token. Berikut adalah contoh curl. Hanya ganti nama organisasi dan lingkungan Anda di URL, dan teruskan Kunci Konsumen:Consumer yang dipisahkan titik dua Nilai secret di header Autentikasi Dasar:

curl -i -X POST --user [client_id]:[client_secret] "http://[org]-[env].apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials"}' -H "Content-Type: application/json"

Dengan keterangan:

  • org adalah nama organisasi Edge Anda (Anda harus merupakan organisasi administrator).
  • env adalah lingkungan di organisasi Anda (seperti pengujian atau prod).
  • client_id adalah ID Konsumen di Aplikasi Developer yang Anda buat sebelumnya.
  • client_secret adalah Rahasia Konsumen di Developer Aplikasi yang Anda buat sebelumnya.

Output (Contoh)

Perintah ini, baik menggunakan perintah CLI edgemicro token, memanggil endpoint menggunakan curl, menampilkan token akses bertanda tangan yang dapat digunakan untuk panggilan telepon. Sesuatu seperti ini:

MIICpDCCAYwCCQDpIvWlpaZJGDANBgkqhkiG9w0BAQFADAUMRIwEAYDVQQDEwls 
b2NhbGhvc3QwHhcNMTYwNDA3MTcxNTM5WhcNMTYwND4MTcxNTM5WjAUMRIwEAYD 
VQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAUAA4IBDwAwggEKAoIBAQD3 
OAQ+kf5FH0S0yuj05ITqUODuUJspBPberRMbqOZYHcFswhB0Yvg6JKWxKWBDP9o 
Xl96dtgH7xPFRqIU0zI452jkMQ1fPz2mSaGwik245yfBku7olooXKRKTRKOUoXa 
q3Hld/RPxGSsWtiyyYtKex7tuFdq0Knm1EhowdTRGIgjNvudeYMka/XPRXuykhd 
xIDxWj4rdX+4GPx9qT2eTQC5nOAC7XHVL7ys4KqsAiv28vw10u400KstFFS8Qho 
7FaE0bOKLolKKadKyA60ha1XIw/uSTD6ZQFWQ+XM3OaRbXePWXnSZioSxXcZT7L 
hMUKbsRXw/TCvRB51LgNAgMBAAEwDQYJKoZIhvcNAQELBQADgEBAOuR1OmE/W6j 
gRAarJB5EQuTEpI/9Zpg5c5RAGjzLhkazsycn7pal+IymUjCV7D0oIxTVuTM8ZZ 
57kR5hF/C1ZypDN9i+KGP2ovX8WOCCXYtIQECgZPB/L/7/k7BDuKN4vFBvWUe3X 
s2oyjnVWy+ASqsW8gHfj8ekhe22bP240Oqkbyg9SZP9ol1tvJX6+M0thYwcTwAd 
ft929Icey/MOTQC0jB2qm0gnIx/7KInFXfS5KoFRJoGrWDeckr3RdBo2LhnPaeZ 
1gPYIqphZ3HfisF5KlBXoR8oT/Ilym/nq5COlv+3L4tMIk18F7BQZB60SRazifz 
pFkIxepyr/0=
      

3. Periksa konfigurasi di Edge Microgateway

  1. Buka file ~/.edgemicro/org-env-config.yaml. Lihat juga "Di mana Edge Microgateway diinstal" di Menginstal Edge Microgateway.
  2. Pastikan properti plugin oauth ini disetel ke false. Mereka adalah false secara {i>default<i}, tetapi sebaiknya periksa kembali:
    oauth:
       allowNoAuthorization: false
       allowInvalidAuthorization: false
  3. Selain itu, di file org-env-config.yaml, pastikan plugin oauth ditambahkan ke elemen plugins:sequence, seperti ini::
    plugins:
       dir: ../plugins
       sequence:
       - oauth
  4. Jika Anda membuat perubahan pada file, muat ulang perubahan ke menjalankan instance Edge Microgateway. Perintah ini mengonfigurasi ulang Edge Microgateway dengan tanpa periode nonaktif:
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    Dengan keterangan:

    • org adalah nama organisasi Edge Anda (Anda harus merupakan administrator org).
    • env adalah lingkungan di organisasi Anda (seperti pengujian atau prod).
    • key adalah kunci yang ditampilkan sebelumnya oleh konfigurasi perintah.
    • secret adalah kunci yang ditampilkan sebelumnya oleh perintah config.

    Contoh

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d

4. Memanggil API dengan aman

Dengan token akses yang ada, Anda kini dapat melakukan panggilan API dengan aman. Contoh:

  curl -i -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhcHBsaWNhdGlvbl
9uYW1lIjoiYmU2YmZjYjAtMWQ0Ni00Y2IxLWFiNGQtZTMxNzRlNTAyMDZkIiwiY2xpZW50X2lkIjoiOGxTTTVIRHdyM
VhIT1ZwbmhURExhYW9FVG5STVpwWk0iLCJzY29wZXMiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIk1pY3JvZ2F0ZXdh
eVRlQcm9kdWN0Il0sImCI6MTQzNTM0NzY5MiwiZXhwIjoxNDM1MzQ5NDkxfQ.PN30Y6uK1W1f2ONPEsBDB_BT31c6
IsjWGfwpz-p6Vak8r767tAT4mQAjuBpQYv7_IU4DxSrnxXQ_q536QYCP4p4YKfBvyqbnW0Rb2CsPFziy_n8HIczsWO
s0p4czcK63SjONaUpxV9DbfGVJ_-WrSdqrqJB5syorD2YYJPSfrCcgKm-LpJc6HCylElFDW8dHuwApaWcGRSV3l5Wx
4A8Rr-WhTIxDTX7TxkrfI4THgXAo37p3au3_7DPB_Gla5dWTzV4j93xLbXPUbwTHzpaUCFzmPnVuYM44FW5KgvBrV0
64RgPmIFUxSqBWGQU7Z1w2qFmWuaDljrMDoLEreI2g" http://localhost:8000/hello/echo

API menampilkan header dan informasi lainnya dari server tiruan.

Mengamankan API dengan kunci API

Jika Anda ingin menggunakan kunci API untuk otorisasi, ikuti langkah-langkah berikut:

1. Mendapatkan kunci API

  1. Di UI Edge, buka Aplikasi Developer yang Anda buat sebelumnya, seperti yang dijelaskan di Bagian 2: Membuat entity di Apigee Edge. Nama Aplikasi ini EdgeMicroTestApp.
  2. Di halaman Aplikasi Developer, tampilkan Kunci Konsumen, lalu salin. Nilai ini kunci API. Anda akan menggunakan kunci ini untuk melakukan panggilan API yang diautentikasi.

2. Periksa konfigurasi di Edge Microgateway

  1. Buka file ~/.edgemicro/org-env-config.yaml. Lihat juga "Di mana Edge Microgateway diinstal" di Menginstal Edge Microgateway.
  2. Pastikan properti plugin oauth ini disetel ke false. Mereka adalah false secara {i>default<i}, tetapi sebaiknya periksa kembali:
    oauth:
       allowNoAuthorization: false
       allowInvalidAuthorization: false
  3. Selain itu, di file org-env-config.yaml, pastikan plugin oauth ditambahkan ke elemen plugins:sequence, seperti ini::
    plugins:
       dir: ../plugins
       sequence:
       - oauth
        
  4. Jika Anda membuat perubahan pada file, muat ulang perubahan ke menjalankan instance Edge Microgateway. Perintah ini mengonfigurasi ulang Edge Microgateway dengan tanpa periode nonaktif:
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    Dengan keterangan:

    • org adalah nama organisasi Edge Anda (Anda harus merupakan administrator org).
    • env adalah lingkungan di organisasi Anda (seperti pengujian atau prod).
    • key adalah kunci yang ditampilkan sebelumnya oleh konfigurasi perintah.
    • secret adalah kunci yang ditampilkan sebelumnya oleh perintah config.

    Contoh

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d

3. Memanggil API secara aman dengan kunci API

Panggil API dengan header x-api-key seperti berikut. Kunci Konsumen nilai yang disalin dari Aplikasi Developer adalah kunci API. Secara {i>default<i}, Edge Microgateway mengharuskan Anda untuk meneruskan kunci di header bernama x-api-key, seperti ini:

curl -i http://localhost:8000/hello/echo -H "x-api-key: [apikey]"

Dengan keterangan:

  • apikey adalah nilai Kunci Konsumen yang diambil dari EdgeMicroTestApp.

Contoh:


curl -i http://localhost:8000/hello/echo -H 'x-api-key: XsU1R4zGXz2ERxa0ilYQ5szwuljr5bB'

Anda kini memiliki Edge Microgateway yang berfungsi penuh dan aman. Pada bagian selanjutnya dari kita akan melihat plugin yang menambahkan fungsionalitas ke Edge Microgateway.

Bagian 5: Menambahkan Pangkal Lonjakan plugin

Di bagian ini, kita akan menambahkan fitur pembatasan kapasitas yang disebut penangkapan lonjakan ke instance Edge Anda Microgateway.

Apa itu plugin?

Plugin adalah modul Node.js yang menambahkan fungsionalitas ke Edge Microgateway. Modul plugin mengikuti pola yang konsisten dan disimpan di lokasi yang dikenal oleh Edge Microgateway, sehingga memungkinkan microgateway untuk menemukan dan memuatnya secara otomatis. Anda dapat membaca lebih lanjut tentang plugin di Gunakan plugin.

Menambahkan penghentian lonjakan plugin

Spike Arrest melindungi jaringan dari lonjakan traffic. Ini men-throttle jumlah permintaan yang diproses oleh instance Edge Microgateway.

Di Edge Microgateway, penghentian lonjakan diterapkan sebagai modul plugin. Untuk mengaktifkannya, Anda memerlukan untuk menambahkannya ke file konfigurasi Edge Microgateway.

  1. Buka file ~/.edgemicro/org-env-config.yaml. Lihat juga "Di mana Edge Microgateway diinstal" di Menginstal Edge Microgateway.
  2. Tambahkan elemen berikut. Anda dapat menambahkannya di mana pun dalam file.
       spikearrest:
          timeUnit: minute   
          allow: 10   
          buffersize: 0   
  3. Tambahkan spikearrest ke elemen edgemicro:sequence, seperti yang ditunjukkan di bawah ini. Urutan properti konfigurasi memberi tahu Edge Microgateway tentang urutan modul plugin telah dijalankan.
    edgemicro:
      home: ../gateway
      port: 8000
      max_connections: -1
      max_connections_hard: -1
      logging:
        level: info
        dir: /var/tmp
        stats_log_interval: 60
      plugins:
        dir: ../plugins
      sequence:
        - spikearrest
        - oauth 
  4. Simpan file konfigurasi.
  5. Muat ulang Edge Microgateway dengan perintah reload. Anda harus menjalankan perintah ini dari direktori tempat Anda memulai Edge Microgateway.
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    Dengan keterangan:

    • org adalah nama organisasi Edge Anda (Anda harus merupakan administrator org).
    • env adalah lingkungan di organisasi Anda (seperti pengujian atau prod).
    • key adalah kunci yang ditampilkan sebelumnya oleh konfigurasi perintah.
    • secret adalah kunci yang ditampilkan sebelumnya oleh perintah config.

    Contoh

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d
  6. Coba panggil API beberapa kali secara berurutan. Setelah panggilan kedua, Edge Microgateway menampilkan error ini:
    {"message":"SpikeArrest engaged","status":503}

Alasannya adalah karena penghentian lonjakan satuan waktu yang ditentukan. Jadi, dalam hal ini, Anda dapat melakukan 10 panggilan dalam satu menit, atau satu panggilan setiap 6 detik.

Untuk mengetahui informasi selengkapnya, lihat "Bagaimana cara kerja penghentian lonjakan?" di Gunakan plugin.

Kredit ekstra: Menambahkan plugin kuota

Dengan mengikuti pola yang sama yang digunakan untuk mengonfigurasi penahanan lonjakan, Anda dapat menambahkan plugin lain, seperti kuota tambahan. Seperti penghentian lonjakan, plugin kuota disertakan dengan setiap Edge Microgateway penginstalan. Kuota menentukan jumlah pesan permintaan yang boleh dikirim oleh aplikasi ke API selama interval waktu yang ditetapkan (menit atau jam).

Untuk mempelajari cara kerja kuota, lihat "Menggunakan plugin kuota" di Menggunakan plugin.

Bagian 6: Menonton analisis di Apigee Edge

Kita sekarang memiliki instance Edge Microgateway yang berfungsi penuh. Mari kita lihat apa saja yang telah kita lakukan. Secara default, modul plugin analisis ditambahkan ke Edge Micro. Modul ini secara otomatis mendorong data analisis dari Edge Micro hingga edge Apigee, yang dipakai oleh sistem Analisis Edge. Mari kita lihat:

  1. Login ke organisasi Anda di Apigee Edge.
  2. Pilih Analytics > Performa Proxy.
  3. Di dasbor Performa Proxy, pilih elemen edgemicro_hello proxy.
  4. Grafik ini menampilkan informasi tentang pola traffic proxy, seperti total traffic, waktu respons rata-rata, waktu respons target rata-rata, dan lainnya.

Anda dapat membaca lebih lanjut tentang dasbor Edge Analytics di halaman beranda Dasbor Analytics di Dokumentasi Edge. Untuk mempelajari plugin lebih lanjut, lihat Menggunakan plugin