README.md

HAPI Server Verifier

Runs a suite of tests on a HAPI server via a web interface or the command line. The tests involve a combination of JSON schema validation and ad-hoc code.

A running instance, documentation, and example output is available at

http://hapi-server.org/verify

and

http://hapi-server.org/verify-dev

Local Installation

Installation is only required if the server to test is not available from a public IP address.

Install Node Version Manager (NVM)

Linux/Mac

1. curl https://raw.githubusercontent.com/creationix/nvm/v0.39.3/install.sh | bash
2. Open a new shell and enter nvm to verify nvm was installed.

Windows

1. Download and execute nvm-setup.exe
2. Open a new PowerShell window and enter nvm to verify nvm was installed.

Install Node and Verifier

# Install NodeJS 16
nvm install 16 

# Clone repository
git clone --recurse-submodules https://github.com/hapi-server/verifier-nodejs.git

# Install required Node.js packages
cd verifier-nodejs; npm install

# Run unit test
node verify.js --test

Command-Line Usage

node verify.js
  --url URL
  [--dataset DATASETID
  --parameter PARAMETERNAME
  --start HAPIDATETIME
  --stop HAPIDATETIME]

If --url URL is provided, output is sent to stdout and a web server is not started. See verify.html for documentation.

See node verify.js --help for additional options.

Server Usage

node verify.js [--port PORT] [--plotserver URL]

If no arguments are provided, a web server is started on port 9999 and plotserver=http://hapi-server.org/plot.

See http://localhost:9999/ for API documentation.

StackBlitz

Schema Validation Only

To execute a schema validation on file or URL, use

node validate.js <file|URL> [--version HAPIVERSION]

If version is not given, the value in the JSON is used.

Examples

node validate.js test/json/capabilities.json
node validate.js http://hapi-server.org/servers/TestData2.0/hapi/capabilities

Contact

Submit questions, bug reports, and feature requests to the issue tracker.