Formatos de archivo

.restorm — el proyecto

El archivo de proyecto. YAML por defecto; los formatos json y json5 también son compatibles.

Contiene el árbol completo —carpetas, carpetas de variables, peticiones, escenarios—, los entornos y sus variables, las listas de valores personalizadas, las enumeraciones, las etiquetas y sus colores, la documentación de API, los ajustes rápidos de ámbito «proyecto», un identificador de proyecto y una versión de formato.

Para confirmar en git. Consulte Proyectos y archivos .restorm.

Modo carpeta

El mismo contenido, desplegado en el disco:

Archivo	Función
restorm.conf	Configuración mínima en la raíz: format: yaml | json | json5
index.yaml (o .yml, .json, .json5)	Un índice por directorio
<index> - <nom>/	Las carpetas, con el prefijo de un índice con ceros a la izquierda

Los caracteres prohibidos por los sistemas de archivos (<>:"/\|?*) se sustituyen por _, y los nombres se recortan a 100 caracteres.

Para confirmar en git.

.restorm/settings.json

Los ajustes de espacio de trabajo, en una subcarpeta del directorio del proyecto. Un JSON disperso: solo figuran en él las claves sobrescritas.

Para confirmar en git si quiere imponer ajustes al equipo.

<projet>.responses.zip

El archivo comprimido del historial de respuestas y de las ejecuciones de escenarios, colocado junto al proyecto.

Para no confirmar en git: añádalo al .gitignore. Crece rápido y puede contener datos de respuesta.

restorm.env

El archivo de secretos local, junto al proyecto.

Para no confirmar nunca en git.

.gitignore recomendado

# Historial de respuestas y de ejecuciones de Restorm
*.responses.zip

# Secretos locales de Restorm
restorm.env

Formatos importados

Restorm lee veinticuatro formatos de importación adicionales. Consulte Importar una API.