blueprint-transactions

Compile HTTP transactions (request-response pairs) from API Blueprint AST

Usage no npm install needed!

<script type="module">
  import blueprintTransactions from 'https://cdn.skypack.dev/blueprint-transactions';
</script>

README

Compile HTTP request-response pairs from API Blueprint AST

Build Status Dependency Status devDependency Status Coverage Status

NPM

This library takes API Blueprint AST and returns specific HTTP transactions (Request and Response pair).

  • Inherits parameters from parent Resource and Action sections
  • Expands URI templates
  • Warns on undefined URI query and path parameters
  • Validates URI parameteres types
  • Assigns origin object pointing to the Blueprint AST
  • Compiles Transaction name string for each transaction

Installation

npm install blueprint-transactions

Usage

compiler = require('blueprint-transactions')

transactions = compiler.compile(ast, './apiay.apib')

Contribution

Any contribution is more than welcome!

Fork, write tests, write clean, readable code which communicate, use scripts/bdd, keep the test coverage and create a pull request.