Перейти до вмісту

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 завантажується десь?
Ні. Перетворення виконується повністю у вашому браузері — документ та все, що він містить, залишаються на вашому пристрої.