Uvoz API-ja
Restorm prepoznaje dvadeset i četiri formata i iz njih rekonstruira cjelovito stablo projekta: mape, zahtjeve, okruženja, API dokumentaciju, enumeracije.
To je gotovo uvijek najbolja polazna točka: nemojte pisati zahtjeve ručno ako specifikacija postoji.
Kako uvesti
Section titled “Kako uvesti”Datoteka ▸ Uvezi (Ctrl+I) prihvaća:
- datoteku s diska;
- URL — korisno za
swagger.jsonili$metadataposlužen na mreži; - zalijepljen sadržaj — tako se naredba
curlpretvara u zahtjev.
Restorm sam prepoznaje format: najprije prema nastavku datoteke, a zatim analizom sadržaja. Vi ne morate ništa birati.
Formati
Section titled “Formati”Specifikacije API-ja
Section titled “Specifikacije API-ja”| Format | Stranica |
|---|---|
| OpenAPI 3.x i Swagger 2.0 | OpenAPI / Swagger |
| GraphQL shema (SDL) | GraphQL |
.proto datoteke i gRPC refleksija | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| tRPC shema | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Zbirke drugih klijenata
Section titled “Zbirke 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 |
Snimke i naredbene linije
Section titled “Snimke i naredbene linije”| Format | Stranica |
|---|---|
| HAR (snimka iz preglednika) | HAR |
curl naredbe | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Što dobivate
Section titled “Što dobivate”Ovisno o bogatstvu izvornog formata:
- mapu okruženja s jednim ili više okruženja i osnovnim URL-om izvučenim iz specifikacije;
- stablo mapa — po etiketi, po usluzi, po resursu, ovisno o formatu;
- po jedan zahtjev za svaku operaciju, vrste koja odgovara protokolu;
- API dokumentaciju pridruženu mapi: modele, opise, sigurnosne sheme, primjere odgovora;
- enumeracije iz specifikacije, upotrebljive kao tip vrijednosti;
- unaprijed ožičena zaglavlja autentifikacije s njihovim varijablama — pogledajte Autentifikaciju.
Nakon uvoza svaki se par ključ / vrijednost čija se vrijednost razrješava u prazno automatski onemogućuje: vaše prvo slanje dakle ne odlazi s rojem praznih zaglavlja.
Dokumentacija uvezenog API-ja
Section titled “Dokumentacija uvezenog API-ja”Uvoz ne proizvodi samo zahtjeve: čuva dokumentaciju API-ja — opise, modele, sigurnost, primjere, enumeracije — dostupnu u kartici Docs stvorene mape. Pogledajte Pristup dokumentaciji uvezenog API-ja i njezino ažuriranje.
Ažuriranje uvoza
Section titled “Ažuriranje uvoza”Dvanaest formata prihvaća ponovnu sinkronizaciju: Restorm uspoređuje novu verziju izvora s postojećim stablom i primjenjuje razliku, bez gubitka vaših izmjena. Pogledajte Ažuriranje iz izvora.
A izvoz?
Section titled “A izvoz?”Restorm generira isječke koda za svaki zahtjev, u svim jezicima relevantnima za njegov protokol. Pogledajte Izvoz koda.