Mem-proxy layanan SOAP

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

Yang akan Anda pelajari

Melalui tutorial ini, Anda akan mempelajari cara:

  • Membuat proxy Edge API dari file WSDL.
  • Mengetahui perbedaan antara jenis proxy RESTful SOAP dan proxy SOAP pass-through.

Dalam tutorial ini, Anda akan mempelajari cara menempatkan proxy Edge API di depan layanan web berbasis SOAP.

Tutorial ini menggambarkan cara membuat RESTful API baru di depan layanan berbasis SOAP. Meskipun tidak dijelaskan secara mendetail di sini, Anda juga dapat membuat proxy pass-through yang menerima payload SOAP dan meneruskannya ke layanan backend.

Yang akan Anda butuhkan

Membuat proxy

Di sini, Anda akan meminta Edge membuat proxy yang akan berada di depan layanan SOAP. Ada dua jenis proxy SOAP API:

  • Jenis proxy REST-SOAP-REST menghasilkan RESTful API baru dengan lapisan terjemahan ke SOAP. Klien menyebutnya seperti layanan RESTful lainnya, yang meneruskan parameter kueri yang dibutuhkan oleh layanan backend. Edge menerjemahkan ini menjadi payload SOAP yang diharapkan oleh layanan.
  • Jenis proxy proxy pass-through memungkinkan klien untuk meneruskan payload SOAP. Ini adalah cara agar panggilan layanan SOAP mendapatkan manfaat dari fitur pengelolaan Edge.

Edge

Untuk melakukan proxy layanan SOAP menggunakan Edge UI:

  1. Login ke apigee.com/edge.
  2. Pilih Develop > API Proxies di menu navigasi sebelah kiri.
  3. Klik +Proxy.
  4. Klik Layanan SABUN.
  5. Di halaman detail Proxy, masukkan informasi berikut:

    Kolom Deskripsi
    Sumber WSDL

    Pilih: URL

    Salin dan tempel URL WSLD berikut di kolom Enter URL:

    https://ws.cdyne.com/delayedstockquote/delayedstockquote.asmx?wsdl

    Klik: Validasi

    Apigee Edge mendapatkan file WSDL dan membacanya untuk menemukan daftar operasi yang didukung layanan SOAP.
    Name

    Biarkan apa adanya: delayedstockquote

    Ini adalah nama proxy API yang Anda buat.
    Jalur dasar Biarkan apa adanya: /delayedstockquote
    Deskripsi Jika perlu, tambahkan deskripsi, seperti: Proxy API WSDL harga saham
  6. Klik Next.
  7. Di halaman Kebijakan umum, di bagian Keamanan: Otorisasi, pilih Lewati (tanpa otorisasi).
  8. Klik Next.
  9. Di halaman WSDL Operations, pilih: REST to SOAP to REST.

    Setelah Anda memilih jenis proxy, Edge akan menampilkan daftar operasi yang akan menghasilkan jalur REST API. Daftar ini memungkinkan Anda memilih di antara operasi yang ditemukan di WSDL (jika Anda memiliki set tertentu yang dicari). Perhatikan bahwa tabel tersebut juga menampilkan resource yang dapat digunakan klien REST untuk memanggil layanan SOAP backend.

    Biarkan semua pilihan lain di halaman sebagaimana adanya.

  10. Klik Next.
  11. Terima default Host Virtual dengan mengklik Next.
  12. Pada halaman Summary, di bagian Optional Deployment, klik Test dan klik Create and deploy.

    Edge menghasilkan proxy RESTful API dan men-deploy-nya ke lingkungan test. Dari WSDL, parameter ini menentukan operasi yang didukung layanan, parameter input, dan sebagainya. Edge menyarankan metode HTTP yang akan digunakan untuk setiap operasi. Biasanya, Edge menerjemahkan operasi menjadi permintaan GET, yang memiliki keuntungan karena dapat di-cache. Edge juga menyiapkan endpoint target backend, yang dapat bervariasi per operasi SOAP.

    Kecuali Anda menyesuaikan proxy API baru (dan Anda tidak sedang mengikuti tutorial ini), maka itu saja yang diperlukan. Anda dapat melanjutkan untuk menguji proxy API baru.

Edge Klasik (Private Cloud)

Untuk melakukan proxy layanan SOAP menggunakan UI Edge Klasik:

  1. Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
  2. Pilih APIs > API Proxy di menu navigasi atas.
  3. Klik + API Proxy.
  4. Klik Layanan SABUN.
  5. Di halaman detail Proxy, masukkan informasi berikut:

    Kolom Deskripsi
    WSDL

    Pilih: Contoh URL

    Lalu pilih:
    ...delayedstocktip.asmx?WSDL

    Klik: Validasi

    Apigee Edge mendapatkan file WSDL dan membacanya untuk menemukan daftar operasi yang didukung layanan SOAP.
    Nama Proxy

    Masukkan: delayedstockquote

    Ini adalah nama untuk proxy yang Anda buat.
    Jalur Dasar Proxy dan Deskripsi Biarkan apa adanya.
  6. Klik Next.
  7. Pada halaman WSDL, buat pilihan berikut:
    Di kolom ini lakukan ini
    Jenis Proxy API

    Pilih: REST ke SOAP ke REST

    Setelah Anda memilih jenis proxy, Edge akan menampilkan daftar operasi yang akan menghasilkan jalur REST API, seperti yang ditunjukkan di sini. Daftar ini memberi Anda kesempatan untuk memilih di antara operasi yang ditemukan di WSDL (jika Anda memiliki set tertentu yang dicari). Perhatikan bahwa tabel tersebut juga menampilkan resource yang dapat digunakan klien REST untuk memanggil layanan SOAP backend.

    Untuk saat ini, biarkan kumpulan operasi pertama dipilih.
    Jenis Port: PendingStockQuoteSoap Pilih ketiga operasi WSDL. Biarkan setelan lain apa adanya.

  8. Klik Next.
  9. Di halaman Keamanan, pilih Teruskan (tidak ada).
  10. Klik Next.
  11. Terima default Host Virtual, lalu klik Next.
  12. Pada halaman Build, terima nilai default, lalu klik Build and Deploy agar Edge mulai membuat proxy.

    Edge menghasilkan proxy RESTful API. Dari WSDL, parameter ini menentukan operasi yang didukung layanan, parameter input, dan sebagainya. Edge menyarankan metode HTTP yang akan digunakan untuk setiap operasi. Biasanya, Edge menerjemahkan operasi menjadi permintaan GET, yang memiliki keuntungan karena dapat di-cache. Edge juga menyiapkan endpoint target backend, yang dapat bervariasi per operasi SOAP.

    Kecuali Anda menyesuaikan proxy baru (dan Anda tidak sedang mengikuti tutorial ini), itu saja yang diperlukan. Anda dapat melanjutkan ke pengujian proxy baru.

Menguji proxy

Untuk mencoba proxy yang telah Anda buat, buka baris perintah dan gunakan cURL. Ketik perintah di bawah ini, di mana:

  • ORG adalah nama organisasi Edge tempat Anda membuat proxy.
  • ENV adalah lingkungan tempat proxy di-deploy.
  • DOMAIN sesuai dengan instance Edge yang Anda gunakan.
curl "https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"

Misalnya, jika organisasi Anda adalah docfood, lingkungannya adalah test, dan Anda menggunakan Edge Enterprise Cloud, Anda dapat menjalankan perintah seperti ini:

curl "https://docfood-test.apigee.net/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"

Jika memasukkan GOOG untuk parameter kueri StockSymbol, Anda akan mendapatkan harga saat ini untuk saham Alphabet Inc. Kelas C. Contoh:

{  
   "GetQuoteResponse":{  
      "GetQuoteResult":{  
         "StockSymbol":"GOOG",
         "LastTradeAmount":819.55,
         "LastTradeDateTime":"2017-02-13T14:33:00",
         "StockChange":5.88,
         "OpenAmount":816.0,
         "DayHigh":820.96,
         "DayLow":815.49,
         "StockVolume":785064,
         "PrevCls":813.67,
         "ChangePercent":"+0.72%",
         "FiftyTwoWeekRange":"663.28 - 841.95",
         "EarnPerShare":27.88,
         "PE":29.4,
         "CompanyName":"Alphabet Inc.",
         "QuoteError":false
      }
   }
}

Mendapatkan Spesifikasi OpenAPI yang dihasilkan secara otomatis

Saat Anda melakukan proxy layanan SOAP menggunakan "REST ke SOAP ke REST", Edge otomatis menghasilkan Spesifikasi OpenAPI. Anda dapat menggunakan Spesifikasi OpenAPI guna membuat dokumentasi API untuk API.

Untuk mendapatkan Spesifikasi OpenAPI, cukup kunjungi URL ini:

curl https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/openapi.json

Kredit tambahan: Bagaimana cara mengetahui parameter resource, verb, dan kueri yang akan digunakan?

Dalam panggilan API pengujian, Anda menggunakan resource dan parameter kueri tertentu dalam panggilan cURL ke layanan SOAP backend. Tapi bagaimana Anda akan mencari tahu sendiri?

Resource dan kata kerja

Di wizard proxy API saat membuat proxy, Anda melihat cara operasi SOAP dipetakan ke kata kerja dan resource API. Tetapi jika Anda tidak mencatatnya, berikut cara mengetahuinya setelah proxy dibuat.

Pada tab Develop proxy API, di panel Navigator sebelah kiri, Anda akan melihat daftar alur di bawah Proxy Endpoints. Klik alur yang Anda minati. Misalnya, alur GetQuote adalah kandidat yang bagus. Kemudian lihat XML di panel Code, yang menampilkan jalur resource dan kata kerja untuk alur dalam elemen <Condition>: /quote dan GET.

Parameter kueri

Dengan memilih alur GetQuote, klik kebijakan pertama pada tampilan alur grafis. Kebijakan ini harus berupa kebijakan Ekstrak Variabel yang menangkap parameter kueri yang diharapkan akan diteruskan: StockSymbol dan LicenseKey. (Jika Anda melakukan penelusuran web untuk layanan SOAP, layanan tersebut akan memberi tahu Anda apa yang harus diteruskan untuk LicenseKey.)

Parameter kueri yang diambil disimpan sebagai variabel dan digunakan oleh kebijakan berikutnya untuk membuat pesan SOAP.