Перейти к содержанию

OpenAPI в коллекцию Postman

Преобразуйте документ OpenAPI или Swagger в готовую к импорту коллекцию Postman v2.1.

Входные данные
Выходные данные

OpenAPI в коллекцию Postman

Вставьте документ OpenAPI 3 или Swagger 2 — JSON или YAML — и этот инструмент построит коллекцию Postman v2.1, которую можно сразу импортировать в Postman, Insomnia или любой другой клиент, поддерживающий этот формат. Каждая операция в спецификации становится запросом, организованным в папках, так что большой API остаётся навигируемым вместо того, чтобы приземлиться одним плоским списком.

Группируйте запросы по тегам или по первому сегменту пути — в зависимости от того, как ваша команда уже думает об API. Включите «Вставить base URL как переменную окружения», чтобы заменить URL сервера на переменную {{baseUrl}}, так что переключение между staging и production — это одна смена окружения вместо редактирования каждого запроса. «Добавить заголовки аутентификации из security scheme» читает определения bearer, API-key или OAuth2 в спецификации и добавляет соответствующий заголовок Authorization или ключ как заполнитель. «Генерировать примеры тел запросов из схем» создаёт пример JSON для каждого запроса из его схемы, следуя ссылкам $ref в документе, так что POST и PUT запросы приходят предзаполненными вместо пустых. Параметры запроса могут быть включены с описаниями, устаревшие endpoints могут быть полностью пропущены, и базовый скрипт проверки успешного кода ответа может быть добавлен к каждому запросу.

Параметры пути, такие как {id}, автоматически становятся переменными пути :id в Postman, и переводы строк CRLF и LF в вставленном документе рассматриваются одинаково. Большие спецификации со сотнями операций преобразуются за один проход; если коллекция превышает лимит вывода, вместо зависания вкладки об этом сообщается.

Всё происходит локально в вашем браузере — документ, который вы вставляете, включая любые детали внутреннего API, которые он содержит, никогда не загружается никуда. Когда коллекция готова, скопируйте её, загрузите как файл или отправьте на вход другого инструмента, чтобы продолжить работу с ней.

FAQ

Поддерживает ли он документы OpenAPI 3 и Swagger 2?
Да. Он читает "servers" и "components.securitySchemes" OpenAPI 3, а также "host"/"basePath"/"schemes" и "securityDefinitions" Swagger 2, и принимает как JSON, так и YAML.
Какие security schemes он распознаёт?
HTTP bearer и basic auth, API-ключи в заголовке, параметре запроса или cookie, и OAuth2/OpenID Connect — каждый соответствует заголовку-заполнителю или параметру запроса.
Как генерируются примеры тел запросов?
Из собственных значений "example" или "default" схемы запроса, где они присутствуют, с откатом на заполнитель, подходящий по типу — ссылки $ref разрешаются в пределах одного документа.
Что происходит со ссылками $ref, которые указывают вне документа?
Они разрешаются на null в генерируемом примере вместо того, чтобы быть отследёнными где-то — ничто в этом инструменте никогда не делает сетевых запросов.
Мой документ API загружается где-то?
Нет. Преобразование выполняется полностью в вашем браузере — документ и всё, что он содержит, остаётся на вашем устройстве.