Formatos de ficheiros

.restorm — o projeto

O ficheiro de projeto. YAML por predefinição; os formatos json e json5 também são suportados.

Contém a árvore completa — pastas, pastas de variáveis, pedidos, cenários —, os ambientes e as respetivas variáveis, as listas de valores personalizadas, as enumerações, as etiquetas e as suas cores, a documentação de API, as definições rápidas de âmbito “projeto”, um identificador de projeto e uma versão de formato.

Faça-lhe commit. Consulte Projetos e ficheiros .restorm.

Modo pasta

O mesmo conteúdo, distribuído pelo disco:

Ficheiro	Função
restorm.conf	Configuração mínima na raiz: format: yaml | json | json5
index.yaml (ou .yml, .json, .json5)	Um índice por diretório
<index> - <name>/	As pastas, prefixadas por um índice com zeros à esquerda

Os caracteres proibidos pelos sistemas de ficheiros (<>:"/\|?*) são substituídos por _, e os nomes são truncados a 100 caracteres.

Faça-lhe commit.

.restorm/settings.json

As definições da área de trabalho, numa subpasta do diretório do projeto. Um JSON esparso: só as chaves sobrepostas aí figuram.

Faça-lhe commit se quiser impor definições à equipa.

<project>.responses.zip

O ficheiro ZIP do histórico de respostas e das execuções de cenários, colocado ao lado do projeto.

Não lhe faça commit — acrescente-o ao .gitignore. Cresce depressa e pode conter dados de resposta.

restorm.env

O ficheiro local de segredos, ao lado do projeto.

Nunca lhe faça commit.

.gitignore recomendado

# Histórico de respostas e de execuções do Restorm
*.responses.zip

# Segredos locais do Restorm
restorm.env

Formatos importados

O Restorm lê vinte e quatro formatos de importação adicionais. Consulte Importar uma API.