View a markdown version of this page

Terhubung ke layanan dengan OpenAPI - AWS Studio Aplikasi
Dapatkan file Spesifikasi OpenAPI dan kumpulkan informasi layananBuat konektor OpenAPI

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Terhubung ke layanan dengan OpenAPI

Untuk menghubungkan App Studio dengan layanan menggunakan OpenAPI untuk memungkinkan pembuat membuat aplikasi yang mengirim permintaan dan menerima tanggapan dari layanan, lakukan langkah-langkah berikut:

  1. Dapatkan file Spesifikasi OpenAPI dan kumpulkan informasi layanan

  2. Buat konektor OpenAPI

Dapatkan file Spesifikasi OpenAPI dan kumpulkan informasi layanan

Untuk menghubungkan layanan ke App Studio dengan OpenAPI, lakukan langkah-langkah berikut:

  1. Buka layanan yang ingin Anda sambungkan ke App Studio dan temukan file JSON Spesifikasi OpenAPI.

    catatan

    App Studio mendukung file Spesifikasi OpenAPI yang sesuai dengan versi OpenAPI Specification Version 3.0.0 atau lebih tinggi.

  2. Kumpulkan data yang diperlukan untuk mengkonfigurasi konektor OpenAPI, termasuk yang berikut:

    • URL dasar untuk menghubungkan ke layanan.

    • Kredentif otentikasi, seperti token atau username/password.

    • Jika berlaku, header apa pun.

    • Jika berlaku, parameter kueri apa pun.

Buat konektor OpenAPI

Untuk membuat konektor untuk OpenAPI

  1. Arahkan ke App Studio.

  2. Di panel navigasi sisi kiri, pilih Konektor di bagian Kel ola. Anda akan dibawa ke halaman yang menampilkan daftar konektor yang ada dengan beberapa detail tentang masing-masing.

  3. Pilih + Buat konektor.

  4. Pilih OpenAPI Connector dari daftar jenis konektor. Sekarang, konfigurasikan konektor Anda dengan mengisi kolom berikut.

  5. Nama: Masukkan nama untuk konektor OpenAPI Anda.

  6. Deskripsi: Masukkan deskripsi untuk konektor OpenAPI Anda.

  7. URL Dasar: Masukkan URL dasar untuk menghubungkan ke layanan.

  8. Metode otentikasi: Pilih metode untuk otentikasi dengan layanan target.

    • Tidak ada: Akses layanan target tanpa otentikasi.

    • Dasar: Akses layanan target menggunakan Nama Pengguna dan Kata Sandi yang diperoleh dari layanan yang terhubung.

    • Token Pembawa: Akses layanan target menggunakan nilai Token dari token otentikasi yang diperoleh dari akun pengguna layanan atau pengaturan API.

    • OAuth 2.0: Akses layanan target menggunakan protokol OAuth 2.0, yang memberikan akses App Studio ke layanan dan sumber daya tanpa berbagi kredenSIAL atau identitas apa pun. Untuk menggunakan metode otentikasi OAuth 2.0, Anda harus terlebih dahulu membuat aplikasi dari layanan yang terhubung yang mewakili App Studio untuk mendapatkan informasi yang diperlukan. Dengan informasi itu, isi kolom berikut:

      1. Alur kredenSIAL klien:

        1. Di ID Kli en, masukkan ID dari layanan target.

        2. Di Rahasia klien, masukkan rahasia dari layanan target.

        3. Di URL token akses, masukkan URL token dari layanan target.

        4. Secara opsional, di Cakupan, masukkan cakupan untuk aplikasi. Cakupan adalah izin atau tingkat akses yang diperlukan oleh aplikasi. Lihat dokumentasi API layanan target untuk memahami cakupannya, dan hanya mengonfigurasi yang dibutuhkan aplikasi App Studio Anda.

        Tambahkan Variabel apa pun yang akan dikirim dengan layanan dengan setiap panggilan, dan pilih Verifikasi koneksi untuk menguji otentikasi dan koneksi.

      2. Alur kode otorisasi:

        1. Di ID Kli en, masukkan ID dari layanan target.

        2. Di Rahasia klien, masukkan rahasia dari layanan target.

        3. Di URL O tor isasi, masukkan URL otorisasi dari layanan target.

        4. Di URL token akses, masukkan URL token dari layanan target.

        5. Secara opsional, di Cakupan, masukkan cakupan untuk aplikasi. Cakupan adalah izin atau tingkat akses yang diperlukan oleh aplikasi. Lihat dokumentasi API layanan target untuk memahami cakupannya, dan hanya mengonfigurasi yang dibutuhkan aplikasi App Studio Anda.

  9. Variabel: Tambahkan variabel yang akan dikirim ke layanan dengan setiap panggilan. Variabel yang ditambahkan selama konfigurasi disimpan dengan aman dan hanya diakses selama runtime aplikasi yang menggunakan koneksi.

  10. Header: Tambahkan header HTTP yang digunakan untuk memberikan metadata tentang permintaan atau respons. Anda dapat menambahkan kunci dan nilai, atau hanya memberikan kunci di mana pembangun dapat memberikan nilai dalam aplikasi.

  11. Parameter kueri: Tambahkan parameter kueri yang digunakan untuk meneruskan opsi, filter, atau data sebagai bagian dari URL permintaan. Seperti header, Anda dapat memberikan kunci dan nilai, atau hanya memberikan kunci yang dapat diberikan oleh pembangun nilai dalam aplikasi.

  12. File Spesifikasi OpenAPI: Unggah file JSON Spesifikasi OpenAPI dengan menyeret dan melepaskan, atau memilih Pilih file untuk menavigasi sistem file lokal Anda dan pilih file yang akan diunggah.

    Setelah ditambahkan, file diproses dan daftar opsi yang tersedia ditampilkan. Pilih operasi yang diperlukan untuk konektor Anda.

  13. Pilih Buat. Konektor yang baru dibuat akan muncul di daftar Konektor.

Sekarang konektor dibuat, pembangun dapat menggunakannya di aplikasi mereka.