Uvoz API-ja

Restorm prepoznaje dvadeset četiri formata i iz njih rekonstruiše kompletno stablo projekta: fascikle, zahteve, okruženja, API dokumentaciju, enumeracije.

To je gotovo uvek najbolja polazna tačka: nemojte pisati svoje zahteve ručno ako specifikacija već postoji.

Kako uvesti

Datoteka ▸ Uvezi (Ctrl+I) prihvata:

• datoteku sa diska;
• URL — korisno za swagger.json ili $metadata poslužen na mreži;
• nalepljeni sadržaj — tako se curl komanda pretvara u zahtev.

Restorm sam prepoznaje format: najpre po ekstenziji datoteke, a zatim analizom sadržaja. Nemate šta da birate.

Formati

API specifikacije

Format	Stranica
OpenAPI 3.x i Swagger 2.0	OpenAPI / Swagger
GraphQL šema (SDL)	GraphQL
.proto datoteke i gRPC refleksija	gRPC
WSDL	SOAP / WSDL
AsyncAPI	AsyncAPI
OData EDMX / CSDL	OData
OpenRPC	OpenRPC
tRPC šema	tRPC
Smithy	Smithy
TypeSpec	TypeSpec
RAML	RAML
WADL	WADL
Thrift	Thrift
API Blueprint	API Blueprint

Kolekcije drugih klijenata

Format	Stranica
Postman	Postman
Insomnia	Insomnia
Bruno	Bruno
Thunder Client	Thunder Client
Paw / RapidAPI	Paw
HTTPie	HTTPie
VS Code REST Client (.http)	REST Client

Snimci i komandne linije

Format	Stranica
HAR (snimak iz pregledača)	HAR
curl komande	cURL
Invoke-RestMethod / Invoke-WebRequest	PowerShell

Šta dobijate

U zavisnosti od bogatstva izvornog formata:

• fasciklu promenljivih sa jednim ili više okruženja i osnovnim URL-om izvučenim iz specifikacije;
• stablo fascikli — po etiketi, po servisu, po resursu, u zavisnosti od formata;
• po jedan zahtev za svaku operaciju, tipa koji odgovara protokolu;
• API dokumentaciju priloženu uz fasciklu: modele, opise, bezbednosne šeme, primere odgovora;
• enumeracije iz specifikacije, upotrebljive kao tip vrednosti;
• unapred povezana zaglavlja autentifikacije sa njihovim promenljivama — vidite Autentifikacija.

Posle uvoza, svaki par ključ / vrednost čija se vrednost razrešava u praznu automatski se isključuje: vaše prvo slanje dakle ne polazi sa rojem praznih zaglavlja.

Dokumentacija uvezenog API-ja

Uvoz ne proizvodi samo zahteve: on čuva dokumentaciju API-ja — opise, modele, bezbednost, primere, enumeracije — koja se može pregledati u kartici Docs napravljene fascikle. Vidite Pristup dokumentaciji uvezenog API-ja i njeno ažuriranje.

Ažuriranje uvoza

Dvanaest formata dozvoljava ponovnu sinhronizaciju: Restorm poredi novu verziju izvora sa postojećim stablom i primenjuje deltu, ne gubeći vaše izmene. Vidite Ažuriranje iz izvora.

A izvoz?

Restorm generiše isečke koda za svaki zahtev, u svim jezicima relevantnim za njegov protokol. Vidite Izvoz koda.