This repo illustrates how to use httpYac for REST API ad-hoc testing and test automation. It defines a sample project structure and environment configuration that you can adjust and/or extend for your specific testing needs.
This document describes the project structure and explains the purpose of the project files and folders. For additional information, check:
The following files and folders are important for the project.
The important modifications to the .gitignore file include:
- Inclusion of the VSCode code snippets, settings, and documentation files that would typically be ignored along with the contents of the
.vscodefolder that holds them. - Exclusion of
.httpyacfolder holding temporary response files. - Exclusion of the private environment variable file (
http-client.private.env.json) intended for local storage of sensitive settings (client secrets, passwords, etc.):
.vscode/*
!.vscode/*.md
!.vscode/settings.json
!.vscode/*.code-snippets
.httpyac/
*.private.env.json
The httpyac.config.js file holds the basic settings for all requests, logging, and general application behaviors including, but not limited to:
- Sets the default log level to
info. - Specifies the domains for the proxy bypass.
The .vscode folder holds Visual Studio Code-specific files, most of which do not need to be checked into a source control system; however, there are several exceptions described in the folder documentation.
The env folder holds the files containing environment variables. For additional information about the environment folder and files, see the folder documentation.
The Tests folder holds the test files which can be logically grouped in subfolders. For additional information about the test folder and files, see the folder documentation.