檔案格式

.restorm — 專案

專案檔案。預設為 YAML；另外也支援 json 與 json5 兩種格式。

它包含完整的樹狀結構 — 資料夾、環境資料夾、請求、情境 — 以及環境及其變數、 自訂值清單、列舉、標籤及其顏色、API 文件、範圍為「專案」的快速設定、一個專案 識別碼與一個格式版本號。

應該 commit。 請參閱 .restorm 專案與檔案。

資料夾模式

同樣的內容，拆散在磁碟上：

檔案	用途
restorm.conf	根目錄下的最小設定檔：format: yaml | json | json5
index.yaml（或 .yml、.json、.json5）	每個目錄一個索引檔
<index> - <name>/	資料夾，前面加上補零對齊的索引

檔案系統不允許的字元（<>:"/\|?*）會被換成 _，名稱則會截斷到 100 個字元。

應該 commit。

.restorm/settings.json

工作區設定，放在專案目錄下的一個子資料夾裡。 這是一份稀疏的 JSON：只有被覆寫過的鍵才會出現在裡面。

如果您想對整個團隊強制套用某些設定，就應該 commit。

<project>.responses.zip

回應歷史記錄與情境執行紀錄的 壓縮檔，放在專案旁邊。

不要 commit — 請把它加進 .gitignore。它會很快變大，而且可能含有回應資料。

restorm.env

放在專案旁邊的本機密鑰檔案。

永遠不要 commit。

建議的 .gitignore

# Restorm 的回應歷史記錄與情境執行紀錄
*.responses.zip

# Restorm 的本機密鑰
restorm.env

匯入的格式

Restorm 另外還能讀取二十四種匯入格式。請參閱 匯入 API。