Generate basic unit test scaffolding for your OpenAPI specification.

oatts is based off of the swagger-test-templates module and the lessons learned during its development.

This is a work in progress.

The goal of oatts is to provide a standalone module for generating Node.js unit test code scaffolding based on a given OpenAPI specification.

The hope is that by providing such a tool, API developers will be encouraged to test the contract between their spec and backend early, often and continuously as the project grows.

There are a couple ways to use oatts.

Install via npm

npm install --save oatts

Then use it in code

var oatts = require('oatts');

var options = {
    // see "Options" section below for available options
};

var tests = oatts.generate('/path/to/openapi.yaml', options);

console.log(tests)

Install globally via npm

npm install -g oatts

Then use in your command line

> oatts generate --help

  Usage: generate [options]

  generate unit test scaffolding for a given OpenAPI/Swagger spec

  Options:

    -h, --help               output usage information
    --host <host>            target hostname to use in test generation
    -p, --paths <paths>      comma separated list of paths to generate tests for
    -e, --sample             generate sample response bodies rather than schema, if applicable
    -s, --spec <spec>        path to the target OpenAPI/Swagger spec document to consume
    -w, --writeTo <writeTo>  directory to write the generated tests to file

> oatts generate -s ./path/to/openapi.yaml -w ./output/dir
> ls ./output/dir
pet-test.js  pet-{petId}-uploadImage-test.js  user-test.js 
. . .

The following options can be passed to the generation function, some/all are exposed in the accompanying CLI:

To test this module simply use the npm script

npm test

Contributors are welcome! Please see CONTRIBUTING.md.

See LICENSE file.