API içe aktarma

Restorm yirmi dört biçim tanır ve bunlardan eksiksiz bir proje ağacı yeniden oluşturur: klasörler, istekler, ortamlar, API dokümantasyonu, numaralandırmalar.

Neredeyse her zaman en iyi başlangıç noktasıdır: bir belirtim varsa isteklerinizi elle yazmayın.

Nasıl içe aktarılır

Dosya ▸ İçe aktar (Ctrl+I) şunları kabul eder:

diskteki bir dosya;
bir URL — çevrimiçi sunulan bir swagger.json ya da $metadata belgesi için kullanışlıdır;
yapıştırılan içerik — bir curl komutunu isteğe dönüştürmenin yolu budur.

Restorm biçimi kendisi algılar: önce dosya uzantısından, ardından içeriği inceleyerek. Sizin seçmeniz gereken bir şey yoktur.

“İstekleri içe aktar” penceresi: bir yol, bir URL ya da bir curl komutunun yapıştırıldığı tek alan, kimlik doğrulama rotası, sabit başlıklar ve gRPC yansıması düğmeleri, bırakma alanı ve öne çıkarılan biçimin kartı

Biçimler

API belirtimleri

Biçim	Sayfa
OpenAPI 3.x ve Swagger 2.0	OpenAPI / Swagger
GraphQL şeması (SDL)	GraphQL
`.proto` dosyaları ve gRPC yansıması	gRPC
WSDL	SOAP / WSDL
AsyncAPI	AsyncAPI
OData EDMX / CSDL	OData
OpenRPC	OpenRPC
tRPC şeması	tRPC
Smithy	Smithy
TypeSpec	TypeSpec
RAML	RAML
WADL	WADL
Thrift	Thrift
API Blueprint	API Blueprint

Diğer istemcilerin koleksiyonları

Biçim	Sayfa
Postman	Postman
Insomnia	Insomnia
Bruno	Bruno
Thunder Client	Thunder Client
Paw / RapidAPI	Paw
HTTPie	HTTPie
VS Code REST Client (`.http`)	REST Client

Yakalamalar ve komut satırları

Biçim	Sayfa
HAR (tarayıcı yakalaması)	HAR
`curl` komutları	cURL
`Invoke-RestMethod` / `Invoke-WebRequest`	PowerShell

Elde ettikleriniz

Kaynak biçimin zenginliğine göre:

bir ya da birkaç ortam içeren bir değişken klasörü; temel URL belirtimden çıkarılır;
bir klasör ağacı — biçime göre etiket, servis ya da kaynak bazında;
her işlem için bir istek, protokole karşılık gelen türde;
klasöre eklenmiş API dokümantasyonu: modeller, açıklamalar, güvenlik şemaları, örnek yanıtlar;
belirtimin, değer türü olarak yeniden kullanılabilen numaralandırmaları;
değişkenleriyle birlikte önceden bağlanmış kimlik doğrulama başlıkları — bkz. Kimlik doğrulama.

İçe aktarmadan sonra, değeri boşa çözülen her anahtar / değer çifti otomatik olarak devre dışı bırakılır: böylece ilk gönderiminiz bir sürü boş başlıkla yola çıkmaz.

İçe aktarılan API’nin dokümantasyonu

Bir içe aktarma yalnızca istek üretmez: API’nin dokümantasyonunu da korur — açıklamalar, modeller, güvenlik, örnekler, numaralandırmalar — ve bunlar oluşturulan klasörün Belgeler sekmesinden görüntülenebilir. Bkz. İçe aktarılan bir API’nin dokümantasyonuna erişme ve güncelleme.

Bir içe aktarmayı güncelleme

On iki biçim yeniden eşitlenebilir: Restorm kaynağın yeni sürümünü mevcut ağaçla karşılaştırır ve değişikliklerinizi kaybetmeden farkı uygular. Bkz. Kaynaktan güncelleme.

Peki dışa aktarma?

Restorm her istek için, protokolüyle ilgili tüm dillerde kod parçacıkları üretir. Bkz. Kod dışa aktarma.