文件格式

.restorm —— 项目文件

项目文件本身。默认为 YAML；同时也支持 json 和 json5 两种格式。

它保存了完整的树结构 —— 文件夹、变量文件夹、请求、场景 —— 以及各个环境及其变量、自定义值列表、枚举、标签及其颜色、API 文档、 作用域为“项目”的快速设置、一个项目标识符和一个格式版本号。

应当提交到版本库。 参阅 项目与 .restorm 文件。

文件夹模式

同样的内容，但拆散存放在磁盘上：

文件	作用
restorm.conf	根目录下的最小配置：format: yaml | json | json5
index.yaml（或 .yml、.json、.json5）	每个目录一个索引文件
<index> - <name>/	各个文件夹，以带前导零的序号作前缀

文件系统禁止的字符（<>:"/\|?*）会被替换成 _，名称则被截断到 100 个字符。

应当提交到版本库。

.restorm/settings.json

工作区设置，存放在项目目录下的一个子文件夹中。 它是一份稀疏 JSON：只有被覆盖过的键才会出现在里面。

如果您希望给团队强制统一设置，就应当提交它。

<project>.responses.zip

响应历史和场景运行记录的归档文件， 与项目文件放在同一目录下。

不要提交 —— 请把它加入 .gitignore。它会迅速变大，而且可能包含响应数据。

restorm.env

本地密钥文件，与项目文件放在一起。

绝对不要提交。

推荐的 .gitignore

# Restorm 的响应历史与场景运行记录
*.responses.zip

# Restorm 的本地密钥
restorm.env

可导入的格式

Restorm 还能读取另外二十四种导入格式。参阅 导入一个 API。