0.0.2 • Published 9 years ago

blueprint-transactions v0.0.2

Weekly downloads
5
License
MIT
Repository
github
Last release
9 years ago

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.