Membuat konektor dan koneksi kustom

Halaman ini menjelaskan cara membuat spesifikasi OpenAPI untuk layanan web, lalu membuat konektor kustom dan koneksi untuk konektor ini.

Sebelum membuat konektor kustom, Anda harus membuat spesifikasi OpenAPI untuk layanan web.

Membuat spesifikasi OpenAPI untuk layanan web

Konektor kustom mendukung OpenAPI 3.0. Anda juga dapat membuat spesifikasi secara manual. Untuk informasi tentang spesifikasi OpenAPI, lihat Spesifikasi OpenAPI.

Anda juga dapat membuat spesifikasi OpenAPI 2.0 secara otomatis menggunakan middleware gin swagger. Untuk informasi selengkapnya, lihat Gin Swagger. Anda harus mengonversi spesifikasi OpenAPI 2.0 ke spesifikasi OpenAPI v3.0 menggunakan Swagger Converter.

Contoh spesifikasi OpenAPI.

{
  "openapi": "3.0.0",
  "info": {
    "title": "Go HTTPbin Proxy Service",
    "description": "A simple Go service that proxies requests to httpbin.org, adding custom headers.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "http://localhost:8080"
    }
  ],
  "paths": {
    "/getData": {
      "get": {
        "summary": "Fetch data from httpbin.org/get",
        "description": "Sends a GET request to httpbin.org/get, including any custom headers.",
        "responses": {
          "200": {
            "description": "Successful response from httpbin.org",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/postData/{id}": {
      "post": {
        "summary": "Post data to httpbin.org/post",
        "description": "Sends a POST request to httpbin.org/post with data, including any custom headers.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"   

                  },
                  "address": {
                    "type": "string"
                  },
                  "gender": {
                    "type": "string"   
                  }
                },
                "required": [
                  "name",
                  "address",
                  "gender"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response from httpbin.org",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid request body"
          }
        }
      }
    }
  }
}

Membuat konektor kustom dan memvalidasi layanan

Anda harus membuat konektor kustom, lalu memvalidasi layanan web dengan menggunakannya dalam koneksi di Integrasi Aplikasi.

Sebelum memulai

Siapkan Private Service Connect (PSC) untuk virtual machine ini, lalu buat lampiran endpoint.

Membuat konektor kustom

  1. Di Konsol, buka halaman Konektor Integrasi > Konektor kustom, lalu pilih atau buat project Google Cloud .

    Buka halaman Konektor kustom

  2. Klik Buat baru untuk membuka halaman Buat konektor kustom.
  3. Di bagian Detail konektor, tentukan kolom yang diperlukan, seperti Nama konektor dan Nama tampilan.Selain itu, masukkan kasus penggunaan untuk konektor di kolom Deskripsi.
  4. Konfigurasikan tujuan konektor untuk akses backend: Aktifkan opsi ini. Tindakan ini akan menampilkan bagian konfigurasi tambahan di halaman.
  5. Service account: Pilih akun layanan yang memiliki peran yang diperlukan.
  6. Logo: Upload gambar ke bucket Cloud Storage untuk menggunakannya sebagai logo konektor.
  7. Di bagian Connector Specification, masukkan URL publik spesifikasi Open API Anda atau upload file spesifikasi ke bucket Cloud Storage.
  8. Di bagian Connector Destination, tambahkan alamat IP lampiran endpoint dan port tempat layanan berjalan.
  9. Di bagian Connector Authentication, pilih No Authentication. Jenis autentikasi tidak didukung untuk konektor Marketplace.
  10. Di bagian Backend Variables, tambahkan variabel yang ingin Anda ambil sebagai input saat membuat koneksi. Variabel ini muncul di halaman pembuatan koneksi dan dikirim pada setiap panggilan API yang dilakukan ke layanan. Nilai yang tidak akan berubah dengan API, seperti kredensial backend pihak ketiga, harus ditambahkan di bagian ini.
  11. Buat konektor kustom. Pastikan Anda telah menentukan logo dan menjelaskan kasus penggunaan untuk konektor kustom.

Membuat koneksi

Setelah membuat konektor kustom, buat koneksi untuk konektor ini.

  1. Di konsol Cloud, buka halaman Konektor Integrasi > Koneksi, lalu pilih atau buat project Google Cloud.

    Buka halaman Koneksi

  2. Klik Buat baru untuk membuka halaman Buat koneksi.
  3. Pilih konektor kustom yang Anda buat.
  4. Tambahkan nilai untuk kolom koneksi yang telah Anda tentukan.
  5. Buat koneksi.

Memvalidasi layanan

Untuk memvalidasi layanan, buat integrasi baru.

  1. Di konsol Google Cloud, buka halaman Application Integration, lalu buat integrasi.
  2. Tambahkan pemicu API dan tugas konektor.
  3. Konfigurasikan tugas konektor untuk menggunakan koneksi yang dibuat pada langkah sebelumnya. Tambahkan Data Mapper jika diperlukan.
  4. Siapkan connectorInputPayload untuk konektor sesuai skema.
  5. Jalankan integrasi untuk memverifikasi bahwa koneksi berfungsi.

Jika Integrasi berhasil berjalan dan menampilkan respons yang diharapkan, layanan web akan divalidasi.

Langkah selanjutnya