Importimi i një API-je
Restorm njeh njëzet e katër formate dhe ndërton prej tyre një pemë projekti të plotë: dosje, kërkesa, mjedise, dokumentacion API-je, numërime.
Ky është pothuajse gjithmonë pikënisja më e mirë: mos i shkruani kërkesat tuaja me dorë nëse ekziston një specifikim.
Si importohet
Section titled “Si importohet”Skedar ▸ Importo (Ctrl+I) pranon:
- një skedar nga disku;
- një URL — e dobishme për një
swagger.jsonose një$metadatatë shërbyer në linjë; - përmbajtje të ngjitur — kështu shndërrohet një komandë
curlnë kërkesë.
Restorm e zbulon formatin vetë: fillimisht nga zgjatimi i skedarit, pastaj duke analizuar përmbajtjen. Ju nuk keni asgjë për të zgjedhur.
Formatet
Section titled “Formatet”Specifikime API-je
Section titled “Specifikime API-je”| Formati | Faqja |
|---|---|
| OpenAPI 3.x dhe Swagger 2.0 | OpenAPI / Swagger |
| Skemë GraphQL (SDL) | GraphQL |
Skedarë .proto dhe reflektim gRPC | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| Skemë tRPC | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Koleksione të klientëve të tjerë
Section titled “Koleksione të klientëve të tjerë”| Formati | Faqja |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Kapje dhe rreshta komande
Section titled “Kapje dhe rreshta komande”| Formati | Faqja |
|---|---|
| HAR (kapje nga shfletuesi) | HAR |
Komanda curl | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Çfarë merrni
Section titled “Çfarë merrni”Në varësi të pasurisë së formatit burimor:
- një dosje variablash me një ose disa mjedise, ku URL-ja bazë nxirret nga specifikimi;
- një strukturë dosjesh — sipas etiketës, sipas shërbimit, sipas burimit, në varësi të formatit;
- një kërkesë për çdo veprim, të tipit që i përgjigjet protokollit;
- dokumentacionin e API-së të bashkëngjitur dosjes: modele, përshkrime, skema sigurie, përgjigje shembull;
- numërimet e specifikimit, të ripërdorshme si tip vlere;
- kokat e vërtetimit të parangjitura bashkë me variablat e tyre — shihni Vërtetimin.
Pas importimit, çdo çift çelës / vlerë vlera e të cilit zgjidhet si bosh çaktivizohet automatikisht: dërgimi juaj i parë nuk niset pra me një re të tërë kokash bosh.
Dokumentacioni i API-së së importuar
Section titled “Dokumentacioni i API-së së importuar”Një importim nuk prodhon vetëm kërkesa: ai ruan edhe dokumentacionin e API-së — përshkrime, modele, siguri, shembuj, numërime — të shfletueshëm në skedën Docs të dosjes së krijuar. Shihni Qasjen dhe përditësimin e dokumentacionit të një API-je të importuar.
Përditësimi i një importimi
Section titled “Përditësimi i një importimi”Dymbëdhjetë formate pranojnë të risinkronizohen: Restorm e krahason versionin e ri të burimit me pemën ekzistuese dhe zbaton deltën, pa i humbur modifikimet tuaja. Shihni Përditësimin nga burimi.
Po eksporti?
Section titled “Po eksporti?”Restorm gjeneron copëza kodi për çdo kërkesë, në të gjitha gjuhët përkatëse për protokollin e saj. Shihni Eksportin e kodit.