Lihat konektor yang didukung untuk Integration Aplikasi.

Melihat Spesifikasi OpenAPI untuk integrasi Anda

Pratinjau — OpenAPI Specification

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dalam 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 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, metode, dan struktur data API integrasi Anda.
• Wujudkan pengembangan dan pemecahan masalah yang lebih efisien dengan menyediakan tampilan API integrasi Anda yang terpusat dan mendetail.
• Ekspos API integrasi Anda dan terintegrasi dengan lancar dengan agen percakapan, seperti agen percakapan Google Cloud.

Apa itu Spesifikasi OpenAPI?

Spesifikasi OpenAPI (OAS) adalah format standar yang tidak bergantung pada bahasa untuk mendeskripsikan RESTful API. Spesifikasi OpenAPI biasanya ditulis dalam format YAML atau JSON, yang 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 secara dinamis untuk integrasi dari editor Integrasi di konsol Google Cloud atau menggunakan panggilan API.

Sebelum memulai

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

Melihat 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 Integrasi Aplikasi.

   Buka Application Integration

2. Di menu navigasi, klik Integrations.

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

3. Klik integrasi yang Spesifikasi OpenAPI-nya 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 tidak 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/integrations/-: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 project Google Cloud Anda.
• LOCATION: Lokasi project Google Cloud 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 merupakan 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 kumpulan kata kunci skema JSON yang terbatas. Untuk 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 dibuat dalam format YAML secara default. Untuk membuat dan melihat Spesifikasi OpenAPI dalam format JSON, tetapkan parameter fileFormat ke JSON dalam panggilan API.
• Integrasi Aplikasi saat ini hanya mendukung kumpulan kata kunci skema JSON terbatas 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 yang terkait dengan jalur API yang mirip dengan gambar berikut:

  

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