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

Проєкти та файли .restorm

Проєкт Restorm живе на вашому диску. Немає ні віддаленого робочого простору, ні власницької синхронізації: ви відкриваєте файл, зберігаєте його, комітите його.

Проєкт Restorm — це один файл (Файл ▸ Створити, потім Зберегти як), типово в YAML. Доступні ще два формати серіалізації: json і json5.

  • дерево: теки, теки середовищ, запити всіх протоколів, сценарії;
  • середовища та їхні змінні, включно з підсередовищами;
  • власні списки значень та імпортовані переліки;
  • теги та їхні кольори;
  • документацію API, прикріплену до тек середовищ;
  • швидкі параметри, збережені «у проєкті»;
  • ідентифікатор проєкту (_projectUuid) і версію формату.

Свідомо — щоб файлом можна було ділитися:

ДаніДе вони живуть
СекретиФайл секретів .env поряд із проєктом — див. Секрети
Історія відповідейАрхів <проєкт>.responses.zip, покладений поряд із проєктом
Швидкі параметри рівня «користувач»Ваші локальні налаштування
ОбранеЛокальне сховище застосунку, індексоване за ідентифікатором проєкту
Розташування workbenchВаші локальні налаштування, індексовані за проєктом
Налаштування робочого простору<тека-проєкту>/.restorm/settings.json

Практичний наслідок: ви можете закомітити .restorm, не витягуючи назовні токен, а ваш колега не отримає ваше розташування вкладок.

Серіалізація, зроблена для git

Section titled “Серіалізація, зроблена для git”

Дві гарантії, які існують лише заради того, щоб контроль версій був придатним до використання:

  1. Канонічний порядок ключів. Ключі ідентичності йдуть попереду (id, name, key, type, folderType, method, url), решта сортується. Порядок елементів у масивах при цьому ніколи не змінюється: це ваш порядок.
  2. Стабільно похідні ідентифікатори. Ідентифікатор сутності обчислюється з її семантичного шляху, а не береться навмання. Двоє людей, що додають той самий запит у те саме місце, отримають той самий ідентифікатор, і це дає злиттю змогу правильно зіставити сутності.

Результат: відкрити й перезберегти проєкт без жодних змін — і жодного діфу не виникне. Див. Вбудований git.

Файл ▸ Останні файли перелічує десять останніх відкритих проєктів; шляхи, що стали недійсними, вилучаються автоматично. Той самий список живить екран привітання.