Skip to main content

Example: Standard configuration

Recipe

In this recipe we will just share how a minimal .restqa.yml configuration file looks like.

Let's use the api from jsonplaceholder

Curl command of the api to test

curl -X GET --url https://jsonplaceholder.typicode.com/users/1

Functional description

Url
https://jsonplaceholder.typicode.com
Path
/users/1

Using RestQA ๐Ÿฆ

version: 0.0.1 #Version of the current manifest
metadata: 
  code: CONFIG_STANDARD # Code name of the project
  name:  Standard Configuration file # Name of the project
  description: An example of a standard restqa configuration file  # Short description of the project
environments: #list of environments
  - name: local # name of your targeted environement
    default: true # In case of multiple environement define which one is default
    plugins: # List of plugin to enable
      - name: "@restqa/restqapi" # Plugin name
        config: # config required for the plugin restqapi
          url: https://jsonplaceholder.typicode.com # Url of your api gateway
    outputs: # List of outputs for current environement
      - type: html # Name of the output
        enabled: true # Enabled output

Run RestQA
restqa run