https://github.com/bukalapak/vanadia

Export API Blueprint .apib file to Postman collection
https://github.com/bukalapak/vanadia

api-blueprint app postman

Last synced: about 2 months ago
JSON representation

Export API Blueprint .apib file to Postman collection

• Host: GitHub
• URL: https://github.com/bukalapak/vanadia
• Owner: bukalapak
• License: mit
• Created: 2017-11-08T03:52:59.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-01-25T07:43:55.000Z (almost 3 years ago)
• Last Synced: 2024-08-04T01:10:19.555Z (5 months ago)
• Topics: api-blueprint, app, postman
• Language: Go
• Size: 104 KB
• Stars: 17
• Watchers: 14
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Vanadia

[![Build Status](https://travis-ci.org/bukalapak/vanadia.svg?branch=master)](https://travis-ci.org/bukalapak/vanadia)

A utility to export [API Blueprint](https://github.com/apiaryio/api-blueprint) `.apib` file to a Postman collection.

## Installation

The latest executables for Linux and OSX are available from the [release page](https://github.com/bukalapak/vanadia/releases), so it can be executed directly:

```sh

$ 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`:

```sh

$ 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](https://github.com/apiaryio/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:

```sh

$ ./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:

```sh

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

```