Оновлення з джерела
Специфікація API живе своїм життям. Повторний імпорт із перезаписом усього знищив би ваші налаштування; імпорт поруч дав би дублікат. Restorm робить третє: він обчислює різницю.
Як це працює
Section titled “Як це працює”Кожен успішний імпорт записує відбиток джерела на створеній теці середовищ. Кнопка Оновити в цій теці отримує джерело, порівнює відбитки й застосовує відмінності замість того, щоб починати з нуля:
- нові операції додаються туди, куди їх помістив би свіжий імпорт;
- у змінених операціях параметри доповнюються тим, що додала специфікація;
- операції, які специфікація позначає застарілими, відзначаються й у дереві показуються приглушено;
- операції, що зникли з джерела, відзначаються як вилучені й показуються закресленими — вони залишаються виконуваними й ніколи не видаляються;
- ваші зміни зберігаються: назва, метод, URL і введені значення ніколи не перезаписуються.
Принцип такий: специфікація має владу над тим, що вона описує, а ви — над усім іншим.
Повний перебіг — де саме кнопка, що показує майстер перед застосуванням, що стається з документацією — описано на сторінці Доступ до документації імпортованого API та її оновлення.
Формати, придатні до повторної синхронізації
Section titled “Формати, придатні до повторної синхронізації”Це стосується дванадцяти форматів:
- OpenAPI 3.x
- Swagger 2.0 (та сама сторінка, що й попередній, але тут рахується окремо: у кожного своя логіка повторної синхронізації)
- GraphQL (SDL)
- gRPC — файл
.protoі серверна рефлексія - SOAP / WSDL
- OData
- AsyncAPI
- Postman
- Insomnia
- Bruno
- OpenRPC
- Smithy
Формати, не придатні до повторної синхронізації
Section titled “Формати, не придатні до повторної синхронізації”HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.
Для них новий імпорт створює нове дерево: зіставити обидва — ваше завдання, або ж імпортуйте до окремої теки.
Окремий випадок: gRPC через рефлексію
Section titled “Окремий випадок: gRPC через рефлексію”Запит gRPC, імпортований через рефлексію, має кнопку Оновити з рефлексії просто на своїй вкладці: це найкоротший шлях, коли служба змінюється прямо під час розробки.