• The design contains /src/ which contains all the necessary files for the boilerplate, and this folder contains directories like constants, containers & libraries.
• src/api.js file is the main app our runner looks for fetching all the necessary configurations & list of API(s) details.
• src/constants/ folder is the main folder where the project's source configurations are located.
• src/containers/ folder keeps containers, meaning all of the APIs.
• src/libraries/ folder will have all the helper modules & store details files.

└── src
  ├── constants
  │   └── index.js
  ├── containers
  │   └── employee (sample)
  │   		├── index.js (sample)
  │   		├── list.js (sample)
  │   		└── single.js (sample)
  ├── libraries
  │   └── store.js
  └── api.js

Based on API Object Model, meaning it is based on API by API test execution & therefore we have divided things into sub-folders for easy test management.

• The API needs two details to execute the tests, and those are domains & apis.

  • domains

    • Domains object is actually a key-value paired, where we require default index & you can add more indexes into the same object

     api.domains = {
     	default: "https://geekyants.com/", // DEFAULT index is REQUIRED!
     	download: "https://dl.geekyants.com/" // OPTIONAL indexes...
     };

  • apis

    • Requires an array of API container modules that would be tested, and the sequence of apis given would be the sequence of their execution.

     api.apis = [
     	require("path/to/containers/api"),
     	require("path/to/containers/api")
     ];

  • store

     // How it works?
     
     // Step #1: Create a Store (Object returning file) if not exists
    
     // Step #2: Register store into the api.js file
     api.store = {
     	token: undefined // undefined is just a default value!
     };
    
     // Step #3: Capture the variable (for eg. token) from response's body
     expected.store = {
     	token: "body.data.jwtToken"
     };
    
     // Step #4: How to use the store variable now?
     //
     // I am using the token in the headers of index API below & to access
     // that token you have to use special syntax ie. [<index-name>].
     // Note: token is same as given in the Step #2 while registering the API app.
     index.headers = {
     	"Content-Type": "application/json",
     	"Authorization":  "Bearer [token]"
     };