Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.57 KB

README.md

File metadata and controls

47 lines (30 loc) · 1.57 KB
Raw

Vanadia

Build Status

A utility to export API Blueprint .apib file to a Postman collection.

Installation

The latest executables for Linux and OSX are available from the release page, so it can be executed directly:

$ wget https://github.com/bukalapak/vanadia/releases/download/${VERSION}/vanadia-${VERSION}.${OS}-amd64.tar.gz
$ tar -xzf vanadia-${VERSION}.${OS}-amd64.tar.gz
$ ./vanadia -h

Manual build

If you want to be in bleeding edge, you can manually build from master:

$ git clone https://github.com/bukalapak/vanadia.git
$ cd vanadia
$ make

Make sure you have Go 1.9 and build-essentials as we should compile Drafter as one of its dependency.

Usage

Let's say we have an API Blueprint document, API.apib in our working directory. Then we can do:

$ ./vanadia --input API.apib --output API.postman_collection.json

Vanadia can also read input from standard input and give its output via standard output; just omit the --input and --output flag.

Configuration

Vanadia is configurable with a vanadia.yml in working directory. Please refer to vanadia.yml in this repository to see what is configurable.

You can also configure Vanadia from other location by specifying the config file:

$ ./vanadia --input api/API.apib --output api/API.postman_collection.json --config api/vanadia.yml