OpenAPI / Swagger içe aktarma

Bu, Restorm’un en kapsamlı içe aktarmasıdır. Üç sürüm tanınır: Swagger 2.0, OpenAPI 3.0 ve OpenAPI 3.1.

İçe aktarma

Dosya ▸ İçe aktar (Ctrl+I), ardından bir swagger.json / openapi.json dosyası ya da doğrudan belirtimin URL’si.

URL 401 ya da 403 yanıtı verirse Restorm, içe aktarma penceresinden çıkmadan bir kimlik doğrulama eklemenizi ve yeniden denemenizi önerir.

Bir OpenAPI içe aktarmasının kenar bölmesinde ürettiği ağaç — her etiket için bir klasör (pet, store, user) — değişken klasörünün giriş alt sekmesinin yanında

İçe aktarılanlar

Belirtimdeki öğe	Restorm’un yaptığı
`servers` (ya da `host` + `basePath` + `schemes`)	Ortamın temel URL’si, sunucu değişkenleri çözülmüş olarak
`tags`	Her etiket için bir klasör, geri kalan için bir Other klasörü
Her işlem	Yöntemi ve yolu dâhil bir HTTP isteği
Parametreler	Yol parametreleri, sorgu parametreleri ve başlıklar, türlenmiş olarak (dize, sayı, tarih-saat, numaralandırma, gizli değer…)
`requestBody`	Gövde, kendi içerik türüyle
`examples`	Verilen örnekle önceden doldurulmuş gövde
`components` / `definitions`	API dokümantasyonu: modeller, açıklamalar
`enum`	Değer türü olarak yeniden kullanılabilen numaralandırmalar
Yanıtlar	İçerik türüne göre belgelenir

$ref başvuruları, bileşenler arasındakiler dâhil, çözülür.

components / definitions satırının altını çizmek gerekir: içe aktarma isteklerle sınırlı kalmaz, API’nin dokümantasyonunun tamamını korur — açıklamalar, modeller, güvenlik şemaları, örnekler, numaralandırmalar. Bu dokümantasyon hem içe aktarmadan doğan değişken klasörünün hem de her isteğin Belgeler sekmesinden görüntülenebilir ve kaynaktan yeniden eşitlenir. Bkz. İçe aktarılan bir API’nin dokümantasyonuna erişme ve güncelleme.

İçe aktarmadan doğan değişken klasörünün Belgeler sekmesi, API dokümantasyonu ve onun içindekiler listesiyle

Güvenlik

Bildirilen güvenlik şemaları önceden bağlanmış başlıklara ya da parametrelere dönüştürülür ve karşılık gelen ortam değişkeni sizin için oluşturulur:

Şema	Restorm’un eklediği
Başlıkta ya da sorguda `apiKey`	Şemanın adını taşıyan bir çift, değeri `{{<schema>}}`
`http` + `basic`	`Authorization: Basic {{<schema>_credentials}}`
`http` + `bearer`, `oauth2`, `openIdConnect`	`Authorization: Bearer {{<schema>_token}}`

Geriye yalnızca değişkeni doldurmak kalır — ya da otomatik yenilemeden yararlanmak için onu bir kimlik doğrulama rotasıyla değiştirmek.

Güncelleme

OpenAPI ve Swagger, yeniden eşitlenebilir biçimler arasındadır: klasörün Yenile düğmesi kaynağı yeniden alır ve Restorm farkı uygular — yeni işlemler eklenir, kaybolan işlemler silinmek yerine kullanımdan kaldırılmış olarak işaretlenir, değişiklikleriniz korunur. Bkz. Kaynaktan güncelleme.