OpenAPI na kolekcję Postman

Konwertuj dokument OpenAPI lub Swagger na gotową kolekcję Postman v2.1 do importu.

Wejście

Grupuj żądania wedługWstaw bazowy URL jako zmienną środowiskaDodaj nagłówki autentykacji ze schematu zabezpieczeniaGeneruj przykładowe treści żądań ze schematówUwzględnij parametry zapytania z opisamiPomiń punkty końcowe oznaczone jako przestarzałeDodaj podstawowy skrypt testowy dla kodu stanu

Wynik

OpenAPI na kolekcję Postman

Wklej dokument OpenAPI 3 lub Swagger 2 — JSON lub YAML — a narzędzie to utworzy kolekcję Postman v2.1, którą możesz zaimportować bezpośrednio do Postmana, Insomnia lub dowolnego klienta, który obsługuje ten format. Każda operacja w specyfikacji staje się żądaniem, zorganizowanym w foldery, aby duże API pozostało nawigowalne zamiast wyładowania się jako jedna płaska lista.

Grupuj żądania według tagu lub po pierwszym segmencie ścieżki — w zależności od tego, co lepiej odpowiada temu, jak Twój zespół myśli o API. Włącz opcję "Wstaw bazowy URL jako zmienną środowiska" i zastąp adres URL serwera zmienną {{baseUrl}}, aby przejście między staging i produkcją było zmianą jednego środowiska zamiast edycji każdego żądania. "Dodaj nagłówki autentykacji ze schematu zabezpieczenia" odczyta definicje bearer, API-key lub OAuth2 w specyfikacji i doda odpowiadające nagłówki autentykacji lub key jako symbole zastępcze. "Generuj przykładowe treści żądań ze schematów" tworzy przykład JSON dla każdego żądania z jego schematu, śledząc odniesienia $ref w dokumencie, tak aby żądania POST i PUT przychodzą wstępnie wypełnione zamiast puste. Parametry zapytania mogą być zawarte z ich opisami, przestarzałe punkty końcowe można całkowicie pominąć, a podstawowy skrypt testowy sprawdzający pomyślny kod stanu można dodać do każdego żądania.

Parametry ścieżki takie jak {id} automatycznie stają się zmiennymi ścieżki Postman :id, a linie z CRLF i LF są traktowane jednakowo. Duże specyfikacje ze setkami operacji konwertują się w jednym przejściu; jeśli kolekcja przekroczy limit wyjścia, narzędzie to oznajmi zamiast zamrażać kartę.

Wszystko dzieje się lokalnie w Twojej przeglądarce — dokument, który wklejasz, łącznie ze wszystkimi wewnętrznymi szczegółami API, które zawiera, nigdy nie jest nigdzie wysyłany. Gdy kolekcja jest gotowa, możesz ją skopiować, pobrać jako plik lub wysłać na wejście innego narzędzia, aby kontynuować pracę.

Częste pytania

Czy obsługuje dokumenty OpenAPI 3 i Swagger 2?

Tak. Odczytuje "servers" i "components.securitySchemes" z OpenAPI 3, a także "host"/"basePath"/"schemes" oraz "securityDefinitions" ze Swagger 2, i akceptuje JSON lub YAML.

Które schematy zabezpieczenia rozpoznaje?

HTTP bearer i basic auth, klucze API w nagłówku, parametrze zapytania lub ciasteczku oraz OAuth2/OpenID Connect — każdy mapuje się na odpowiadający nagłówek zastępczy lub parametr zapytania.

Jak się generują przykładowe treści żądań?

Ze słów kluczowych "example" lub "default" schematu żądania, jeśli są obecne, w przeciwnym razie zwraca się symbol zastępczy odpowiedni dla typu — odniesienia $ref są rozpoznawane w tym samym dokumencie.

Co się dzieje z $ref wskazującymi poza dokument?

Rozpoznawane na null w wygenerowanym przykładzie zamiast śledzenia gdziekolwiek — nic w tym narzędziu nigdy nie tworzy żądania sieciowego.

Czy mój dokument API jest gdzie wyładowany?

Nie. Konwersja odbywa się całkowicie w przeglądarce — dokument i wszystko w nim pozostaje na Twoim urządzeniu.

OpenAPI na kolekcję Postman

Powiązane narzędzia

OpenAPI na kolekcję Postman

Częste pytania