Preskoči na vsebino
100% lokalno

OpenAPI v Postman zbirko

Pretvori OpenAPI ali Swagger dokument v Postman v2.1 zbirko, ki je pripravljena za uvoz.

Vhod
Izhod

OpenAPI v Postman zbirko

Prilepite OpenAPI 3 ali Swagger 2 dokument — JSON ali YAML — in to orodje ustvari Postman v2.1 zbirko, ki jo lahko direktno uvozite v Postman, Insomnia ali katerega koli drugega odjemalca, ki podpira to obliko. Vsaka operacija iz specifikacije postane zahtevek, organiziran v mape, tako da ostane velika API pregledno namesto da bi bila prikazana kot en sam seznam.

Grupirajte zahteve po oznakah ali po prvem segmentu poti, ne glede na to, kaj bolje ustreza načinu, na katerega vaša ekipa razmišlja o API-ju. Vključite "Vstavi osnovni URL kot spremenljivko okolja", da nadomestite naslov URL strežnika s spremenljivko {{baseUrl}}, tako da je preklapljanje med preskusnimi in proizvodnimi okolji samo ena sprememba spremenljivke namesto urejanja vsakega zahtevka. "Dodaj glavo avtentifikacije iz sheme varnosti" bere specifikacijske definicije nosilca, ključa API ali OAuth2 in dodaja ustrezno glavo Authorization ali ključ kot rezervo. "Generiraj primere telesa zahteve iz shem" ustvari primer JSON za vsak zahtevek iz njegove sheme, sledimo referencam znotraj dokumenta, tako da zahtevki POST in PUT pridejo vnaprej izpolnjeni namesto prazni. Parametre poizvedbe je mogoče vključiti z njihovimi opisi, zastarele končne točke je mogoče v celoti preskočiti, in osnovno testno kodo, ki preverja uspešno statusno kodo, je mogoče dodati vsakemu zahtevku.

Parametri poti kot {id} se samodejno spremenijo v Postmanove spremenljivke :id, končnice vrstic CRLF in LF v prilepljeni dokument pa se obravnavajo enako. Velike specifikacije s stotinami operacij se pretvorijo v enem prehodu; če bi zbirka presegla mejno vrednost izhoda, vam to orodje to javi namesto da bi zamrznilo zavihek.

Vse se dogaja lokalno v vašem brskalniku — dokument, ki ga prilepite, vključno z vsemi internimi podrobnostmi API-ja, ki jih vsebuje, nikoli ne bo poslano nikamor. Ko je zbirka pripravljena, jo lahko kopirate, prenesete kot datoteko ali je pošljete kot vhod drugemu orodju, da nadaljujete z delom na njej.

FAQ

Ali podpira tako OpenAPI 3 kot Swagger 2 dokumente?
Da. Bere OpenAPI 3 "servers" in "components.securitySchemes" ter Swagger 2 "host"/"basePath"/"schemes" in "securityDefinitions", in sprejema tako JSON kot YAML.
Katere sheme varnosti prepozna?
HTTP nosilec in osnovno avtentifikacijo, ključe API v glavi, parametru poizvedbe ali piškotku ter OAuth2/OpenID Connect — vsak se preslika na ustrezno rezervno glavo ali parameter poizvedbe.
Kako se generirajutudi primeri telesa zahteve?
Iz lastnih vrednosti "example" ali "default" v shemi zahtevka, kjer obstajajo, z umikom na primerno rezervo glede na tip — reference $ref se razrešijo v istem dokumentu.
Kaj se zgodi z $ref, ki kažejo zunaj dokumenta?
Se razrešijo kot null v generijanem primeru namesto da se sledijo nekje — nič v tem orodju nikoli ne naredi omrežnega zahtevka.
Ali je moj dokument API naložen negdje?
Ne. Pretvorba teče v celoti v vašem brskalniku — dokument in vse v njem ostanejo na vaši napravi.