Toolkit for converting API Blueprint files to JSON and consuming that JSON
npm install @ianwalter/blueline --save-devExample of generating API Blueprint JSON files using the CLI:
npx blueline src/docs docs
👍 Generated API Blueprint JSON!Example of consuming an API Blueprint JSON file and asserting that one of the request properties has a certain value:
import { Blueprint } from '@ianwalter/blueline'
import json from './docs/account.json'
// Verbose usage:
const createAccountRequest = new Blueprint(json)
.group('Account') // Returns the Resource Group named Account.
.resource('/account') // Returns the Resource with a uriTemplate of /account.
.action('POST') // Returns the Action with a method of POST.
.example(0) // Returns the first example object.
.request(0) // Returns the first request object in the example.
.body() // Returns the JSON-parsed request body.
// Simplified usage:
// Get an example request with a unique name:
const { body } = new Blueprint(json).request('Update Account').json@ianwalter/drakov- Mock server that implements the API Blueprint specification
Apache 2.0 with Commons Clause - See LICENSE
Created by Ian Walter