Melihat Spesifikasi OpenAPI untuk integrasi Anda

Application Integration memberikan kemampuan untuk membuat dan melihat Spesifikasi OpenAPI secara dinamis dari integrasi yang dipublikasikan dan 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.
• Memungkinkan pengembangan dan pemecahan masalah yang lebih efisien dengan memberikan tampilan API integrasi Anda yang mendetail dan terpusat.
• Mengekspos API integrasi Anda dan berintegrasi secara lancar dengan agen percakapan, lihat Membangun agen percakapan dengan Application Integration.

Apa yang dimaksud dengan Spesifikasi OpenAPI?

OpenAPI Specification (OAS) adalah format standar yang tidak bergantung pada bahasa untuk mendeskripsikan RESTful API. Biasanya ditulis dalam format YAML atau JSON, Spesifikasi OpenAPI 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.

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 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:

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"
          

Memahami Spesifikasi OpenAPI

Application Integration membuat Spesifikasi OpenAPI untuk integrasi yang Anda publikasikan sesuai dengan standar Spesifikasi OpenAPI 3.0. Tabel berikut menjelaskan elemen Spesifikasi OpenAPI yang dihasilkan di Application Integration:

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.
• Application Integration 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 terkait jalur API yang mirip dengan gambar berikut:

  

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

Langkah berikutnya

• Membangun agen percakapan dengan Application Integration.
• Pelajari pemicu API.
• Pelajari Menguji dan memublikasikan integrasi.