Mengimpor OpenAPI / Swagger

Inilah impor Restorm yang paling lengkap. Tiga versi dikenali: Swagger 2.0, OpenAPI 3.0, dan OpenAPI 3.1.

Mengimpor

File ▸ Impor (Ctrl+I), lalu pilih file swagger.json / openapi.json, atau langsung URL spesifikasinya.

Jika URL-nya menjawab 401 atau 403, Restorm menawarkan Anda untuk melampirkan autentikasi lalu mencoba lagi, tanpa keluar dari modal impornya.

Apa yang diimpor

Elemen spesifikasi	Yang dibuat Restorm darinya
servers (atau host + basePath + schemes)	URL dasar lingkungannya, dengan variabel server yang sudah diselesaikan
tags	Satu folder per label, ditambah folder Other untuk sisanya
Setiap operasi	Sebuah permintaan HTTP, lengkap dengan metode dan jalurnya
Parameter	Parameter jalur, kueri, dan header, yang bertipe (string, angka, tanggal-waktu, enumerasi, rahasia…)
requestBody	Body-nya, dalam tipe kontennya
examples	Body yang sudah terisi dengan contoh yang disediakan
components / definitions	Dokumentasi API: model, deskripsi
enum	Enumerasi yang dapat dipakai ulang sebagai tipe nilai
Respons	Didokumentasikan menurut tipe kontennya

Semua $ref diselesaikan, termasuk yang melintasi komponen.

Baris components / definitions layak ditekankan: impornya tidak terbatas pada permintaan, ia menyimpan seluruh dokumentasi API — deskripsi, model, skema keamanan, contoh, enumerasi. Dokumentasi itu dapat dilihat di tab Docs pada folder variabel hasil impor maupun pada tab setiap permintaan, dan dapat disinkronkan ulang dari sumbernya. Lihat Mengakses dan memperbarui dokumentasi sebuah API yang diimpor.

Keamanan

Skema keamanan yang dideklarasikan diterjemahkan menjadi header atau parameter yang sudah terpasang, lengkap dengan variabel lingkungan terkait yang dibuatkan untuk Anda:

Skema	Yang dipasang Restorm
apiKey di header atau kueri	Sebuah pasangan yang dinamai menurut skemanya, bernilai {{<schema>}}
http + basic	Authorization: Basic {{<schema>_credentials}}
http + bearer, oauth2, openIdConnect	Authorization: Bearer {{<schema>_token}}

Anda tinggal mengisi variabelnya — atau menggantinya dengan sebuah rute autentikasi agar memperoleh pembaruan otomatis.

Batasan yang diketahui

apiKey yang dikirim lewat cookie tidak terpasang otomatis (OpenAPI 3). Skema keamanan yang dirujuk tetapi tidak dideklarasikan diabaikan diam-diam.

Memperbarui

OpenAPI dan Swagger termasuk format yang dapat disinkronkan ulang: tombol Segarkan pada foldernya mengambil sumbernya dan Restorm menerapkan deltanya — operasi baru ditambahkan, operasi yang hilang ditandai usang alih-alih dihapus, dan perubahan Anda dipertahankan. Lihat Memperbarui dari sumber.