Přeskočit na obsah

OpenAPI do Postman kolekce

Převeďte dokument OpenAPI nebo Swagger na hotovou kolekci Postman v2.1 k importu.

Vstup
Výstup

OpenAPI do Postman kolekce

Vložte dokument OpenAPI 3 nebo Swagger 2 — JSON nebo YAML — a tento nástroj vytvoří kolekci Postman v2.1, kterou můžete importovat přímo do Postmanu, Insomnie nebo libovolného klienta, který tento formát podporuje. Každá operace ve specifikaci se stane požadavkem, organizovaným do složek, aby zůstalo velké API navigovatelné místo toho, aby skončilo jako jeden plochý seznam.

Seskupte požadavky podle značky nebo podle prvního segmentu cesty — podle toho, co lépe odpovídá tomu, jak váš tým o API přemýšlí. Zapněte možnost "Vložit základní URL jako proměnnou prostředí" a nahraďte adresu URL serveru proměnnou {{baseUrl}}, aby byl přechod mezi staging a produkcí změnou jednoho prostředí místo úpravy každého požadavku. "Přidat ověřovací záhlaví ze schématu zabezpečení" přečte definice bearer, API-key nebo OAuth2 ve specifikaci a přidá odpovídající ověřovací nebo key záhlaví jako zástupný symbol. "Generovat ukázkové těla požadavků ze schémat" vytvoří příklad JSON pro každý požadavek z jeho schématu, přičemž sleduje reference $ref v dokumentu, takže požadavky POST a PUT přijdou předvyplněné místo prázdných. Parametry dotazu mohou být zahrnuty s jejich popisy, zastaralé koncové body je možné zcela přeskočit a základní testovací skript kontrolující úspěšný stavový kód lze přidat do každého požadavku.

Parametry cesty jako {id} se automaticky stanou proměnnými cesty Postman :id a řádky s CRLF a LF mají stejné zacházení. Velké specifikace se stovkami operací se konvertují v jednom průchodu; pokud by kolekce překročila limit výstupu, nástroj to oznámí místo zamrznutí záložky.

Všechno se děje lokálně ve vašem prohlížeči — dokument, který vložíte, včetně všech vnitřních detailů API, které obsahuje, se nikdy neodešle nikam. Když je kolekce hotová, můžete ji zkopírovat, stáhnout jako soubor nebo poslat na vstup jiného nástroje, abyste pokračovali v práci.

Časté dotazy

Podporuje dokumenty OpenAPI 3 i Swagger 2?
Ano. Čte "servers" a "components.securitySchemes" z OpenAPI 3 a také "host"/"basePath"/"schemes" a "securityDefinitions" ze Swagger 2, a přijímá JSON nebo YAML.
Která schémata zabezpečení rozpoznává?
HTTP bearer a basic auth, klíče API v záhlaví, parametru dotazu nebo cookie a OAuth2/OpenID Connect — každý se mapuje na odpovídající zástupné záhlaví nebo parametr dotazu.
Jak se generují ukázkové těla požadavků?
Z vlastních hodnot "example" nebo "default" schématu požadavku, pokud jsou přítomny, jinak se vrací typ-vhodný zástupný symbol — reference $ref se vzájemně řeší v rámci stejného dokumentu.
Co se stane s $ref, které ukazují mimo dokument?
Vyřeší se na null v generovaném příkladu místo sledování kdekoli — nic v tomto nástroji nikdy nevytváří síťový požadavek.
Je můj dokument API někde nahrán?
Ne. Konverze probíhá zcela v prohlížeči — dokument a vše v něm zůstává na vašem zařízení.