Імпорт OpenAPI / Swagger
Це найповніший імпорт у Restorm. Розпізнаються три версії: Swagger 2.0, OpenAPI 3.0 та OpenAPI 3.1.
Імпорт
Section titled “Імпорт”Файл ▸ Імпортувати (Ctrl+I), а потім файл swagger.json /
openapi.json або безпосередньо URL специфікації.
Якщо URL відповідає 401 чи 403, Restorm запропонує приєднати
автентифікацію й спробувати ще раз, не полишаючи модального вікна імпорту.
Що імпортується
Section titled “Що імпортується”| Елемент специфікації | Що з нього робить Restorm |
|---|---|
servers (або host + basePath + schemes) | Базовий URL середовища з обчисленими змінними сервера |
tags | По теці на кожну мітку плюс теку Other для решти |
| Кожна операція | Запит HTTP разом із методом і шляхом |
| Параметри | Параметри шляху, запиту та заголовки, типізовані (рядок, число, дата/час, перелік, секрет…) |
requestBody | Тіло у своєму типі вмісту |
examples | Тіло, заздалегідь заповнене наданим прикладом |
components / definitions | Документація API: моделі, описи |
enum | Переліки, придатні до повторного використання як тип значення |
| Відповіді | Задокументовані за типом вмісту |
$ref обчислюються, зокрема й наскрізь через компоненти.
Рядок components / definitions варто підкреслити: імпорт не обмежується
запитами — він зберігає всю документацію API: описи, моделі, схеми безпеки,
приклади, переліки. Її можна переглянути у вкладці Docs теки середовищ,
створеної імпортом, а також у вкладці кожного запиту, і вона повторно
синхронізується з джерелом. Див.
Доступ до документації імпортованого API та її оновлення.
Безпека
Section titled “Безпека”Оголошені схеми безпеки перетворюються на заздалегідь під’єднані заголовки або параметри, для яких за вас створюється відповідна змінна середовища:
| Схема | Що задає Restorm |
|---|---|
apiKey у заголовку або в запиті | Пару, названу за схемою, зі значенням {{<schema>}} |
http + basic | Authorization: Basic {{<schema>_credentials}} |
http + bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
Залишається лише заповнити змінну — або замінити її маршрутом автентифікації, щоб мати автоматичне поновлення.
Оновлення
Section titled “Оновлення”OpenAPI та Swagger належать до форматів, придатних до повторної синхронізації: кнопка Оновити в теці отримує джерело, і Restorm застосовує різницю — нові операції додаються, зниклі позначаються як застарілі, а не видаляються, ваші зміни зберігаються. Див. Оновлення з джерела.