Import OpenAPI Schema
Alih-alih menambahkan API action satu per satu, Anda dapat mengimpor beberapa sekaligus dari definisi OpenAPI (Swagger) yang sudah ada. Tutorial ini memandu Anda melalui alur import — dari membuka modal hingga mempublikasikan hasilnya.
Kapan Menggunakan Fitur Ini
Gunakan Import OpenAPI Schema ketika Anda sudah memiliki spec OpenAPI untuk backend Anda. Alih-alih mengisi nama, HTTP method, endpoint, dan parameter secara manual untuk setiap operasi, qlar membaca spec tersebut dan membuat semua API action dalam satu langkah.
Skenario umum:
- Anda mengekspor spec dari Postman, Swagger UI, atau API gateway Anda
- Tim backend memelihara file OpenAPI sebagai bagian dari workflow pengembangan mereka
- Anda sedang memigrasikan sekumpulan endpoint dari tool lain
Langkah 1 — Buka Modal Import
Pada halaman Custom API, klik Import OpenAPI Schema di bagian atas halaman. Sebuah dialog modal akan terbuka.
Langkah 2 — Pilih Format Schema
Atur Schema Format ke JSON atau YAML sesuai file spec Anda.
Tip: Jika Anda mengunggah file pada langkah berikutnya, qlar mendeteksi format secara otomatis dari ekstensi file (
.json,.yaml, atau.yml) dan mengatur field ini untuk Anda.
Langkah 3 — Sediakan Schema
Anda memiliki dua pilihan:
Pilihan A — Paste
Salin spec OpenAPI Anda dan tempel langsung ke editor Paste your OpenAPI schema here.
Pilihan B — Unggah file
Klik Choose File dan pilih file .json, .yaml, atau .yml dari komputer Anda. Isi file otomatis mengisi editor.
Langkah 4 — Convert Schema
Klik Convert Schema. Dialog konfirmasi muncul yang merangkum berapa banyak API action yang akan dibuat.
Klik Confirm untuk melanjutkan. qlar mem-parsing spec dan menambahkan satu API action per operasi ke daftar Anda.
Catatan: Setiap action yang diimpor ditambahkan tanpa authentication. Setelah mengimpor, konfigurasikan credential untuk API Anda — baik satu per satu (lihat bagian Authentication di Call API) maupun sekaligus menggunakan Set Authentication.
Langkah 5 — Tinjau API yang Diimpor
Modal tertutup dan daftar Custom API Anda kini menampilkan action yang baru diimpor. Periksa setiap action untuk memastikan nama, deskripsi, HTTP method, endpoint, dan parameter terlihat benar.
Anda dapat mengklik ikon edit (pensil) pada action mana pun untuk menyesuaikan detailnya sebelum mempublikasikan.
Langkah 6 — Publikasikan Semua Perubahan
Klik Save all changes di bagian bawah halaman Custom API. Dialog konfirmasi akan muncul — klik Confirm untuk mempublikasikan.
Semua API action yang diimpor kini aktif pada agent Anda.
Apa yang Diimpor
| Field OpenAPI | Dipetakan ke field qlar |
|---|---|
operationId / summary | Action Name |
description | Description |
method | HTTP Method |
servers[0].url + path | Target URI |
parameters | Properties (path, query) |
requestBody | Properties (body) |
Catatan: Import mencakup field OpenAPI 3.x yang paling umum. Beberapa konstruk lanjutan (mis. schema
allOf/oneOfyang kompleks, parameter upload file) mungkin tidak terpetakan sepenuhnya dan perlu disesuaikan secara manual setelah import.
Langkah Selanjutnya
- Tambah authentication — Lihat Set Authentication untuk menerapkan credential ke semua API yang diimpor sekaligus.
- Tes sebuah action — Buka panel edit untuk action yang diimpor, klik Test API, isi nilai sampel, dan klik Send Request untuk memverifikasi endpoint merespons dengan benar.
- Perbaiki deskripsi — AI menggunakan action name dan description untuk memutuskan kapan memanggil setiap API. Jika deskripsi tidak ada atau terlalu umum, perbarui agar lebih spesifik.
Halaman Terkait
- Call API — daftarkan satu API action secara manual dan pahami semua opsi yang tersedia
- Set Authentication — terapkan credential ke beberapa API sekaligus
- Using Plugins — gunakan integrasi siap pakai alih-alih mengonfigurasi API mentah