Home

plroebuck edited this page Apr 6, 2016 · 13 revisions
Clone this wiki locally

Welcome to the abao wiki!

News

  • [2016-04-06] New pre-release (v0.4.0-beta.7) now available!
  • [2016-03-12] New pre-release (v0.4.0-beta.5) now available!
  • [2016-02-26] New pre-release (v0.4.0-beta.4) now available!
  • [2016-02-19] New pre-release (v0.4.0-beta.3) now available!

Significant User-Visible Change

With beta5 release, a --server argument replaced the old required command-line parameter. Below the former variable specifies your RAML file, and the latter your API endpoint (a.k.a., web service)

$ RAML="webservice.raml"
$ ENDPOINT="http://localhost:8080"

If using current version (beta5) and RAML-specified baseUri property matches endpoint:

$ abao ${RAML}

If using current version (beta5), but without matching RAML-specified baseUri property:

$ abao ${RAML} --server ${ENDPOINT}

If using an older version of abao:

$ abao ${RAML} ${ENDPOINT}

How To Determine Which Version Is Installed

$ abao --version

Generate Skeleton Hooksfile

$ HOOKS="test_webservice_hooks.js"
$ abao ${RAML} --generate-hooks > ${HOOKS}

Edit the skeleton hooksfile to setup each request and validate the response.

Then have abao invoke your path-specific logic as part of its validation.

$ abao ${RAML} --hooks=${HOOKS}

Notes

If your RAML references external JSON schema files, the --schemas argument will be needed to preload them.