apival-cli v1.0.4

ApiVal

Client

Installation

To install the editor, clone the repository, then go to the cli folder, and then run

npm install apival-cli --global

Usage

./apival-cli --input file.json [--help] [--silent]

Documentation

Running a test file

You can run a test file by executing the following command:

./apival-cli --input path/to/file.json

This command will automatically execute every test in the JSON file. To run only one specific test, use the following command:

./apival-cli --input path/to/file.json --test-name "Test Name"

To suppress all output, pass the --silent (or -s) parameter when running apival-cli.

You can find a demo JSON file (generated with the visual editor described below) here.

Visual Editor

The visual editor is available at apival.colorcode.me/editor.

It allows you to define tests, to create and export test files, as well as editing existing text files.

If you want to build the visual editor on your machine, you have to do it using angular-cli. You can find more information about it here.

About

This tool is a work in progress and is currently developed by Sorin Banica - you can find more about my work here.