Preskočiť na obsah

OpenAPI do Postman kolekcie

Konvertujte dokument OpenAPI alebo Swagger na hotovú kolekciu Postman v2.1 na import.

Vstup
Výstup

OpenAPI do Postman kolekcie

Vložte dokument OpenAPI 3 alebo Swagger 2 — JSON alebo YAML — a tento nástroj vytvorí kolekciu Postman v2.1, ktorú môžete importovať priamo do Postmanu, Insomnie alebo akéhokoľvek klienta, ktorý tento formát podporuje. Každá operácia v špecifikácii sa stane požiadavkou, organizovanou v priečinkoch, aby zostala veľká API navigovateľná namiesto toho, aby pristála ako jeden plochý zoznam.

Zoskupujte požiadavky podľa značky alebo podľa prvého segmentu cesty — podľa toho, čo lepšie zodpovedá tomu, ako o API premýšľa váš tím. Zapnite možnosť "Vložiť základnú URL ako premennú prostredia" a nahraďte URL servera premennou {{baseUrl}}, aby bol prechod medzi staging a produkciou zmenou jedného prostredia namiesto úpravy každej požiadavky. "Pridať autentifikačné hlavičky zo schémy zabezpečenia" prečíta definície bearer, API-key alebo OAuth2 v špecifikácii a pridá zodpovedajúcu autentifikačnú alebo key hlavičku ako zástupný symbol. "Generovať vzorové telá požiadaviek zo schém" vytvorí príklad JSON pre každú požiadavku z jej schémy, pričom bude sledovať referencie $ref v dokumente, takže požiadavky POST a PUT prídu vopred vyplnené namiesto prázdnych. Parametre dotazu môžu byť zahrnuté s ich popismi, zastarané koncové body je možné úplne preskočiť a základný testovací skript kontrolujúci úspešný stavový kód je možné pridať do každej požiadavky.

Parametre cesty ako {id} sa automaticky stanú premennými cesty Postman :id a riadky s CRLF a LF majú rovnaké zaobchádzanie. Veľké špecifikácie so stovkami operácií sa konvertujú v jednom prechode; ak by kolekcia presiahla limit výstupu, nástroj to oznámi namiesto zamrznutia záložky.

Všetko sa deje lokálne v prehliadači — dokument, ktorý vložíte, vrátane všetkých interných detailov API, ktoré obsahuje, sa nikdy nenahrá nikam. Keď je kolekcia hotová, môžete ju skopírovať, stiahnuť ako súbor alebo poslať na vstup iného nástroja, aby ste pokračovali v práci.

Časté otázky

Podporuje to dokumenty OpenAPI 3 aj Swagger 2?
Áno. Číta "servers" a "components.securitySchemes" z OpenAPI 3 ako aj "host"/"basePath"/"schemes" a "securityDefinitions" zo Swagger 2, a akceptuje JSON alebo YAML.
Ktoré schémy zabezpečenia rozpoznáva?
HTTP bearer a basic auth, API klíče v hlavičke, parametri dotazu alebo cookie, a OAuth2/OpenID Connect — každé sa mapuje na zodpovedajúcu zástupnú hlavičku alebo parameter dotazu.
Ako sa generujú vzorové telá požiadaviek?
Z vlastných hodnôt "example" alebo "default" schémy požiadavky, ak sú prítomné, inak sa vracia typ-vhodný zástupný symbol — referencie $ref sa vzájomne riešia v rovnakom dokumente.
Čo sa stane s $ref, ktoré smerujú mimo dokument?
Riešia sa na null v generovanom príklade namiesto sledovania gdziekolwiek — nič v tomto nástroji nikdy nevytvára sieťovú požiadavku.
Je môj dokument API niekde nahratý?
Nie. Konverzia prebieha úplne v prehliadači — dokument a všetko v ňom zostávajú na vašom zariadení.