Přeskočit na obsah

Import API

Restorm rozpoznává dvacet čtyři formátů a na jejich základě rekonstruuje kompletní strom projektu: složky, požadavky, prostředí, dokumentaci API, výčtové typy.

Je to téměř vždy nejlepší výchozí bod: nepište požadavky ručně, pokud už specifikace existuje.

Soubor ▸ Importovat (Ctrl+I) přijímá:

  • soubor z disku;
  • URL — užitečné pro swagger.json nebo $metadata dostupné online;
  • vložený obsah — právě tak se z příkazu curl stane požadavek.

Restorm rozpozná formát sám: nejprve podle přípony souboru, potom analýzou obsahu. Nemusíte nic vybírat.

Modální okno „Importovat požadavky“: jediné pole, do kterého se vkládá cesta, URL nebo příkaz curl, tlačítka pro ověřovací trasu, fixní hlavičky a reflexi gRPC, oblast pro přetažení souborů a karta zvýrazněného formátu

FormátStránka
OpenAPI 3.x a Swagger 2.0OpenAPI / Swagger
Schéma GraphQL (SDL)GraphQL
Soubory .proto a reflexe gRPCgRPC
WSDLSOAP / WSDL
AsyncAPIAsyncAPI
OData EDMX / CSDLOData
OpenRPCOpenRPC
Schéma tRPCtRPC
SmithySmithy
TypeSpecTypeSpec
RAMLRAML
WADLWADL
ThriftThrift
API BlueprintAPI Blueprint
FormátStránka
PostmanPostman
InsomniaInsomnia
BrunoBruno
Thunder ClientThunder Client
Paw / RapidAPIPaw
HTTPieHTTPie
VS Code REST Client (.http)REST Client
FormátStránka
HAR (záznam z prohlížeče)HAR
Příkazy curlcURL
Invoke-RestMethod / Invoke-WebRequestPowerShell

Podle toho, jak bohatý je zdrojový formát:

  • složku proměnných s jedním nebo více prostředími a se základní URL vytaženou ze specifikace;
  • strom složek — podle štítku, podle služby nebo podle zdroje, podle formátu;
  • jeden požadavek na operaci, typu odpovídajícího protokolu;
  • dokumentaci API připojenou ke složce: modely, popisy, bezpečnostní schémata, ukázkové odpovědi;
  • výčtové typy ze specifikace, znovu použitelné jako typ hodnoty;
  • předem zapojené ověřovací hlavičky i s jejich proměnnými — viz Ověřování.

Po importu je každý pár klíč / hodnota, jehož hodnota se vyhodnotí jako prázdná, automaticky vypnutý: vaše první odeslání tedy neodejde s rojem prázdných hlaviček.

Import nevytváří jen požadavky: uchovává také dokumentaci API — popisy, modely, zabezpečení, příklady, výčtové typy — dostupnou na kartě Dokumentace vytvořené složky. Viz Přístup k dokumentaci importovaného API a její aktualizace.

Dvanáct formátů lze znovu synchronizovat: Restorm porovná novou verzi zdroje s existujícím stromem a použije rozdíl, aniž byste přišli o své úpravy. Viz Aktualizace ze zdroje.

Restorm generuje ukázky kódu pro každý požadavek, ve všech jazycích relevantních pro jeho protokol. Viz Export kódu.