Lihat konektor yang didukung untuk Application Integration.

Melihat Spesifikasi OpenAPI untuk integrasi Anda

Pratinjau — OpenAPI Specification

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dari Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Integrasi Aplikasi memberikan kemampuan untuk membuat dan melihat Spesifikasi OpenAPI dari integrasi yang dipublikasikan secara dinamis yang dikonfigurasi dengan satu atau beberapa pemicu API. Dengan mengakses Spesifikasi OpenAPI integrasi, Anda dapat:

• Dapatkan pemahaman yang komprehensif tentang endpoint API, metode, dan struktur data integrasi Anda.
• Aktifkan pengembangan dan pemecahan masalah yang lebih efisien dengan memberikan tampilan API integrasi yang mendetail dan terpusat.
• Mengekspos API integrasi dan mengintegrasikan dengan lancar dengan agen percakapan, lihat Membangun agen percakapan dengan Application Integration.

Apa itu Spesifikasi OpenAPI?

Spesifikasi OpenAPI (OAS) adalah format standar yang tidak bergantung pada bahasa untuk mendeskripsikan RESTful API. Spesifikasi OpenAPI, yang biasanya ditulis dalam format YAML atau JSON, menyajikan deskripsi formal elemen API seperti URL dasar, jalur dan kata kerja, header, parameter kueri, jenis konten, model permintaan dan respons, dan lainnya. Untuk mengetahui informasi selengkapnya tentang Spesifikasi OpenAPI, lihat Spesifikasi OpenAPI.

Catatan: Integrasi Aplikasi hanya mendukung Spesifikasi OpenAPI versi 3.0.1.

Membuat dan melihat Spesifikasi OpenAPI

Anda dapat membuat dan melihat Spesifikasi OpenAPI untuk integrasi secara dinamis dari editor Integrasi di konsol Google Cloud atau menggunakan panggilan API.

Sebelum memulai

• Pastikan integrasi Anda dikonfigurasi dengan satu atau beberapa pemicu API. Untuk mengetahui informasi tentang cara mengonfigurasi pemicu API, lihat Pemicu API.
• Publikasikan integrasi Anda. Untuk mengetahui informasi tentang cara memublikasikan integrasi, lihat Menguji dan memublikasikan integrasi.

Lihat Spesifikasi OpenAPI

Untuk melihat Spesifikasi OpenAPI untuk integrasi Anda, pilih salah satu opsi:

Konsol

Untuk melihat Spesifikasi OpenAPI untuk integrasi tertentu, lakukan langkah-langkah berikut:

1. Buka halaman Application Integration.

   Buka Integrasi Aplikasi

2. Di menu navigasi, klik Integrations.

   Halaman Integrasi akan muncul, yang mencantumkan semua integrasi yang tersedia dalam project Google Cloud .

3. Klik integrasi yang Spesifikasi OpenAPInya ingin Anda lihat. Tindakan ini akan membuka integrasi di editor Integrasi.
4. Klik (menu Tindakan) di toolbar editor Integrasi, lalu pilih Lihat spesifikasi OpenAPI.

   Panel Lihat spesifikasi OpenAPI akan muncul dan menampilkan Spesifikasi OpenAPI integrasi. Spesifikasi OpenAPI yang dihasilkan, secara default, berisi semua pemicu API yang dikonfigurasi dalam integrasi.

   • Untuk melihat Spesifikasi OpenAPI untuk pemicu API tertentu, pilih pemicu API dari menu drop-down API.
   • Untuk mendownload Spesifikasi OpenAPI sebagai file YAML, klik download (Download).

Catatan: Anda hanya dapat melihat dan mendownload Spesifikasi OpenAPI, dalam format YAML, untuk satu integrasi dari editor Integrasi dalam satu waktu. Untuk melihat dan mendownload Spesifikasi OpenAPI dalam format YAML atau JSON, ikuti petunjuk di bagian API.

API

Metode generateOpenApiSpec Application Integration API memungkinkan Anda melihat Spesifikasi OpenAPI untuk integrasi menggunakan panggilan API.

Gunakan perintah curl berikut untuk melihat Spesifikasi OpenAPI untuk satu atau beberapa integrasi di region yang sama:

Tips: curl biasanya sudah diinstal sebelumnya untuk sistem operasi Linux dan macOS. Jika Anda belum memiliki curl, Anda dapat mendownloadnya dari halaman rilis dan download curl.

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -d '{
    "apiTriggerResources": [{
    "integrationResource": "INTEGRATION_NAME",
    "triggerId": ["api_trigger/TRIGGER_NAME", "api_trigger/TRIGGER_NAME_2", "api_trigger/TRIGGER_NAME_n"]
    },
    {
    "integrationResource": "INTEGRATION_NAME",
      "triggerId": ["api_trigger/TRIGGER_NAME"]
    }],
    "fileFormat": "DOC_TYPE"
    }' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:generateOpenApiSpec"
          

Ganti kode berikut:

• TRIGGER_NAME, TRIGGER_NAME_2, TRIGGER_NAME_n: Nama pemicu API dalam integrasi yang ingin Anda lihat Spesifikasi OpenAPI-nya.
• INTEGRATION_NAME: Nama integrasi Anda.
• DOC_TYPE: Jenis dokumen yang akan dibuat. Nilai berikut didukung: YAML atau JSON.
• PROJECT_ID: ID Google Cloud project Anda.
• LOCATION: Lokasi Google Cloud project Anda.
  Catatan: Anda hanya dapat melihat Spesifikasi OpenAPI untuk beberapa integrasi di region yang sama.

Memahami Spesifikasi OpenAPI

Integrasi Aplikasi membuat Spesifikasi OpenAPI untuk integrasi yang dipublikasikan dengan mengikuti standar Spesifikasi OpenAPI 3.0. Tabel berikut menjelaskan elemen Spesifikasi OpenAPI yang dihasilkan di Integrasi Aplikasi:

Elemen	Deskripsi
openapi	Versi Spesifikasi OpenAPI yang digunakan.
info	Informasi tentang integrasi, seperti nama (judul), deskripsi, dan versi yang dipublikasikan.
servers	URL server yang menghosting integrasi.
paths	Jalur dibuat untuk setiap pemicu API yang dipilih dalam integrasi. URL server yang digabungkan dengan jalur membentuk endpoint API untuk melakukan panggilan API. Kolom Request dan Response diisi berdasarkan variabel input dan output yang dikonfigurasi untuk pemicu API yang sesuai. Catatan: Integrasi Aplikasi saat ini hanya mendukung serangkaian kata kunci skema JSON yang terbatas. Untuk mengetahui informasi tentang kata kunci yang didukung, lihat Pertimbangan.
components	Kolom schemas berisi skema JSON untuk variabel input dan output pemicu API. Kolom securitySchemes berisi informasi autentikasi untuk pemicu API.

Pertimbangan

Pertimbangan berikut berlaku saat melihat Spesifikasi OpenAPI untuk integrasi Anda:

• Spesifikasi OpenAPI hanya dibuat untuk integrasi yang dipublikasikan.
• Spesifikasi OpenAPI hanya dibuat untuk integrasi yang dikonfigurasi dengan satu atau beberapa pemicu API.
• Spesifikasi OpenAPI hanya dibuat untuk integrasi di region yang sama.
• Spesifikasi OpenAPI dihasilkan dalam format YAML secara default. Untuk membuat dan melihat Spesifikasi OpenAPI dalam format JSON, tetapkan parameter fileFormat ke JSON dalam panggilan API.
• Saat ini, Application Integration hanya mendukung kumpulan terbatas kata kunci skema JSON berikut:
  • type
  • items
  • properties
  • description
  • required
  • array
  • object
  • oneOf
  • allOf
  • anyOf
  • not
  • null
  • enum
  • additionalProperties
  • default
• Saat memvalidasi spesifikasi OpenAPI menggunakan Swagger Editor, Anda mungkin mengalami error semantik terkait jalur API yang mirip dengan gambar berikut:

  

  Error ini dapat diabaikan dengan aman. Spesifikasi OpenAPI masih valid.

Langkah berikutnya

• Bangun agen percakapan dengan Integrasi Aplikasi.
• Pelajari pemicu API.
• Pelajari Menguji dan memublikasikan integrasi.