Skip to main content


Pre requisite

In order to run you will to have :

  • NodeJs installed
  • Npm or Yarn installed

Install with npm

To install RestQA globally run the command:

npm install @restqa/restqa -g

Initialize your first project

In order to initialize your first project run the command:

restqa init -y

The -y option will create the project using the default values.

restqa init

And Voila! Your first test has been setup using the RestQA demo environment.

A typical RestQA project will have the following source file structure:

- .restqa.yml            # RestQA configuration file
- test/
  - integrations/
    - welcome.feature    # Sample test scenario

You can look at your folder and you will see the RestQA configuration file .restqa.yml.

version: 0.0.1
  code: APP
  name: app
  description: Configuration generated by restqa init
  - name: local
    default: true
      - name: restqapi
      - type: html
        enabled: true
      - type: file
        enabled: true
          path: restqa-result.json

And your first sample test scenario was created on the file: ./tests/integration/welcome-restqa.feature

Feature: Welcome to the RestQA community

Scenario: Get the list of useful RestQA resources
Given I have the api gateway hosted on ""
  And I have the path "/welcome.json"
  And I have the method "GET"
When I run the API
Then I should receive a response with the status 200
  And the response body should be equal to:
  "documentation": {
    "description": "Access to the official documentation",
    "href": ""
  "examples": {
    "description": "A series of RestQA implementation examples",
    "href": ""
  "message": "Thank you for installing RestQa, Let's continue our Test Automation together",
  "promotion": {
    "github": {
      "action": "Give us a a star",
      "href": ""
    "linkedin": {
      "action": "Follow us",
      "href": ""
    "medium": {
      "action": "Follow us",
      "href": ""
    "twitter": {
      "action": "Follow us",
      "href": ""
    "youtube": {
      "action": "Subscribe to the channel",
      "href": ""
  "sources": {
    "description": "RestQa is Open Source, feel free to contribute",
    "href": ""
  "support": {
    "description": "Please ask and answer questions here.",
    "href": ""

Run the Sample test scenario.

From now you can run the test scenario using the command

restqa run

And Voila your first test scenario has been executed and passed!

You can see the result into the ./report folder.

Access to the RestQA Dashboard

If you are looking for a user friendly interface, take a look at the restqa dashboard, by using the command:

restqa dashboard


screenshot dashboard

More information on this feature