Инструменты API

Postman в OpenAPIпроверьте результат переноса

Загрузите коллекцию, спецификацию или окружение и просмотрите запросы и отчёт перед экспортом.

Автопреобразование

Коллекция, спецификация или окружение

{
  "info": {
    "name": "Pet API",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.example.com"
    }
  ],
  "item": [
    {
      "name": "Pets",
      "item": [
        {
          "name": "List pets",
          "request": {
            "method": "GET",
            "url": "{{baseUrl}}/pets?limit=10",
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "demo-token"
                }
              ]
            }
          },
          "event": [
            {
              "listen": "test",
              "script": {
                "exec": [
                  "pm.test(\"status\", () => pm.response.to.have.status(200));"
                ]
              }
            }
          ]
        },
        {
          "name": "Create pet",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}/pets",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\"name\":\"Miso\"}"
            }
          },
          "response": [
            {
              "code": 201,
              "status": "Created",
              "body": "{\"id\":7,\"name\":\"Miso\"}"
            }
          ]
        }
      ]
    }
  ]
}

Результат

Текст остаётся в этом браузере. API-запросы и скрипты не выполняются, внешние ссылки не загружаются.

Параметры вывода

Режим преобразованияФормат OpenAPI

Маскировать распознанные реквизиты

Переносятся примеры, а не полный контракт. Проверьте отчёт и оставшиеся заглушки.

500 000 символов · глубина 60 · 50 000 узлов · 1 000 запросов · 500 сообщений · 5 секунд.

Результат устарел. Перед экспортом повторите проверку.

Копирование и скачивание включают всё выбранное представление. Маскирование меняет только результат.

Postman в OpenAPI пригодится, когда набор работающих вызовов нужно превратить в основу документации API. Запрос описывает один конкретный случай, а контракт — допустимые входные данные. Поэтому при переносе важно видеть, какая информация не вошла в новый файл.

При создании коллекции из спецификации сохраняйте исходный контракт. Заглушки авторизации, определения ответов и ограничения схем не полностью воспроизводятся набором запросов. Успешное преобразование ещё не означает готовность к вызову сервиса.

Зачем проверять Postman в OpenAPI здесь

Запросы и пропуски видны рядом

Postman в OpenAPI рекурсивно читает вложенные папки и сохраняет их путь как тег операции. Список показывает прочитанные вызовы, а отчёт — скрипты, переменные и неперенесённые поля. Совпадение метода и пути останавливает обработку, чтобы один запрос не затёр другой.

Карточки запросов из папок соединяются с документом API, а карточка скрипта переходит в ветку предупреждения.

Проверьте секреты до передачи файла

При форматировании и экспорте окружения маскирование включено по умолчанию. Распознанные секретные значения заменяются в результате. Отключённые строки окружения отдельно отмечаются в отчёте, поэтому уменьшение числа строк в .env можно объяснить.

Строки переменных переходят в файл настроек; секрет закрыт маской, а отключённая строка остаётся в отчёте.

Три решения перед сохранением

Сначала выберите тип исходного файла

Переключение направления не заменяет текст. Затем загрузите пример для выбранного режима или подходящий локальный файл. Коллекция должна объявлять схему 2.1, а файл окружения — содержать массив values.

Дождитесь актуального результата

Автоматический режим запускается через 350 мс после редактирования. Отключите его, чтобы внести несколько правок и выполнить преобразование сочетанием Ctrl/Cmd + Enter. Изменения ввода или настроек блокируют копирование и скачивание до нового результата.

Экспортируйте проверенное представление

Результат сохраняет преобразованный документ, Запросы — полный список, Отчёт — все коды и пути источника. На экране показано по 50 строк, но экспорт включает все элементы выбранного представления.

От примеров запросов к контракту и настройкам

Преобразование в обе стороны

Этот конвертер коллекций Postman создаёт OpenAPI 3.0.3 в JSON или YAML. Направление OpenAPI в Postman принимает версии 3.0 и 3.1 и формирует Collection 2.1. Локальные ссылки, необходимые для сведений об операциях, разрешаются внутри переданного документа.

Примеры без выдуманных ограничений

Значения query и заголовков становятся строковыми примерами. Тело JSON остаётся примером без автоматического вывода required или enum. В обратном направлении используются example или default; если значения нет, создаётся именованная заглушка вместо случайных тестовых данных.

Правила выбора сервера и авторизации

Поддерживается отображение Basic, Bearer и API Key в заголовке или query. При обратном преобразовании приоритет имеют операция, путь, затем корень; выбирается первый эффективный сервер. Несколько вариантов, отсутствие сервера и сложные сочетания условий безопасности отмечаются в отчёте.

Окружение обрабатывается отдельно

Переменные окружения берутся из отдельно экспортированного JSON. Активные скалярные значения становятся строками, null — пустой строкой. Кавычки сохраняют пробелы, переводы строк и знак доллара. Неверные или повторяющиеся ключи прекращают экспорт.

Что потребуется дополнить вручную

Ограниченный набор версий: Допустимы Collection 2.1 и спецификация OpenAPI 3.0.x или 3.1.x. Swagger 2.0, другие версии коллекций и OpenAPI 3.2 отклоняются. Создаваемая спецификация всегда имеет версию 3.0.3; форматирование не выполняет миграцию версии.
Без среды выполнения скриптов: Скрипты перед запросом и тесты не выполняются и не преобразуются в проверки. Форматирование сохраняет их текст, а конвертация сообщает о пропуске. Динамические переменные не вычисляются; окружения, глобальные значения и Vault автоматически не объединяются.
Обратное преобразование теряет часть контракта: Определения ответов и ограничения проверки не переносятся в коллекцию, о чём сообщает отчёт. Сложная сериализация параметров, callbacks, webhooks, потоки OAuth, подписи и содержимое двоичных файлов не поддерживаются. Отдельный пример не доказывает все правила сервиса.
Ссылки и отсутствующие адреса: Внешние файлы и URL-ссылки не загружаются. Отсутствующая локальная цель или неверная спецификация останавливают обработку. Неразрешённая базовая переменная коллекции даёт сервер /; в обратном направлении без сервера используется example.invalid. Оба случая отражаются в отчёте.
Маскирование не находит любой секрет: Распознаются чувствительные имена ключей, переменные secret, значения авторизации, cookie и реквизиты в URL. Тела JSON проверяются по структуре, прочие тела скрываются целиком. В обычном тексте и скриптах секреты могут остаться. Исходный ввод не изменяется.
Ограничения ресурсов и синтаксиса: До 500 000 символов ввода, глубина 60, 50 000 узлов, 1 000 запросов, 500 сообщений, 2 000 000 символов в пакете результата и пять секунд работы. Повторные ключи, неточные числа, псевдонимы YAML, пользовательские теги и несколько документов отклоняются.

Вопросы про Postman в OpenAPI

Поддерживаются ли спецификации YAML и JSON?

Да, в режиме OpenAPI → коллекция. Коллекции и окружения читаются только как JSON. Выбор формата влияет лишь на создаваемую спецификацию; коллекция сохраняется в JSON, окружение — в .env.

Теряются ли данные при преобразовании между форматами?

Да. Исполняемый сценарий и декларативный контракт содержат разную информацию. Проверьте все пункты отчёта и используйте результат как начало миграции. Преобразование не проверяет работоспособность авторизации или ответы реального сервиса.

Как задать baseUrl в созданной коллекции?

Приоритет: операция > путь > корень. Первый эффективный URL становится baseUrl, следующие операции получают отдельные базовые переменные. Для переменных сервера подставляются значения по умолчанию. Если сервера нет, добавляется example.invalid и запись в отчёте.

Можно ли исключить секретные переменные из экспорта?

При включённом маскировании значения с отметкой secret или чувствительным именем заменяются на [REDACTED]. Это управляет только результатом данного инструмента и не меняет права экспорта Postman. Произвольные секреты в тексте обнаруживаются не всегда.

Можно ли экспортировать коллекцию со всеми переменными окружения?

Автоматически — нет. Экспортируйте окружение отдельно и выберите Окружение → .env. Обрабатываются лишь активные значения этого файла. Отсутствующие локальные, глобальные или Vault-значения не загружаются.

Документ дал неожиданный результат?

Начните с небольшого набора вызовов

Используйте Postman в OpenAPI для небольшой коллекции, сравните список и отчёт с оригиналом, затем заполните неразрешённые заглушки и сохраните файл для следующего этапа.

Вернуться к документу Все инструменты

Postman в OpenAPIпроверьте результат переноса