Імпорт API
Restorm розпізнає двадцять чотири формати й відтворює з них повне дерево проєкту: теки, запити, середовища, документацію API, переліки.
Це майже завжди найкраща відправна точка: не пишіть свої запити вручну, якщо специфікація вже існує.
Як імпортувати
Section titled “Як імпортувати”Файл ▸ Імпортувати (Ctrl+I) приймає:
- файл із диска;
- URL — зручно для
swagger.jsonчи$metadata, доступних онлайн; - вставлений вміст — саме так команда
curlперетворюється на запит.
Restorm визначає формат самостійно: спершу за розширенням файлу, потім за аналізом вмісту. Вибирати нічого не треба.
Формати
Section titled “Формати”Специфікації API
Section titled “Специфікації API”| Формат | Сторінка |
|---|---|
| OpenAPI 3.x та Swagger 2.0 | OpenAPI / Swagger |
| Схема GraphQL (SDL) | GraphQL |
Файли .proto та рефлексія gRPC | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| Схема tRPC | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Колекції інших клієнтів
Section titled “Колекції інших клієнтів”| Формат | Сторінка |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Захоплення й командні рядки
Section titled “Захоплення й командні рядки”| Формат | Сторінка |
|---|---|
| HAR (захоплення в браузері) | HAR |
Команди curl | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Що ви отримуєте
Section titled “Що ви отримуєте”Залежно від багатства вихідного формату:
- теку середовищ з одним чи кількома середовищами та базовим URL, узятим зі специфікації;
- дерево тек — за міткою, за службою, за ресурсом, залежно від формату;
- по запиту на кожну операцію відповідного протоколу;
- документацію API, прикріплену до теки: моделі, описи, схеми безпеки, зразки відповідей;
- переліки зі специфікації, придатні до повторного використання як тип значення;
- заздалегідь під’єднані заголовки автентифікації з їхніми змінними — див. Автентифікація.
Після імпорту будь-яка пара ключ / значення, значення якої обчислюється в порожнє, вимикається автоматично: отже, ваше перше надсилання не вирушить із хмарою порожніх заголовків.
Документація імпортованого API
Section titled “Документація імпортованого API”Імпорт створює не лише запити: він зберігає документацію API — описи, моделі, безпеку, приклади, переліки, — доступну у вкладці Docs створеної теки. Див. Доступ до документації імпортованого API та її оновлення.
Оновлення імпорту
Section titled “Оновлення імпорту”Дванадцять форматів припускають повторну синхронізацію: Restorm порівнює нову версію джерела з наявним деревом і застосовує різницю, не втрачаючи ваших змін. Див. Оновлення з джерела.
А експорт?
Section titled “А експорт?”Restorm генерує фрагменти коду для кожного запиту всіма мовами, доречними для його протоколу. Див. Експорт коду.