public
Last active

  • Download Gist
howto.md
Markdown

How to convert a legacy Apiary Blueprint to API Blueprint using CLI

CLI Tools Required

Install following CLI tools:

  1. Apiary Blueprint Parser

    $ npm install apiary-blueprint-parser
    

    NOTE: Requires local installation of Node.js (>0.8)

  2. Apiary Blueprint AST Convertor

    $ gem install apiary_blueprint_convertor
    
  3. Matter Compiler

    $ gem install matter_compiler
    

Convert an Apiary Blueprint

Given a legacy Apiary bluerpint file legacy_blueprint.apib run the following

$ node_modules/apiary-blueprint-parser/bin/blueprint-parser legacy_blueprint.apib | apiary_blueprint_convertor | matter_compiler --format json > new_blueprint.md

Notes

Not tested on Windows.

This pipeline does not insert FORMAT: 1A at the top. Shouldn't it?

@jrep

I have just released matter_compiler v0.3.0 which introduce the --set-blueprint-format option.

$ matter_compiler no-format.yaml 
# My API

and

$ matter_compiler no-format.yaml --set-blueprint-format
FORMAT: 1A

# My API

Please sign in to comment on this gist.

Something went wrong with that request. Please try again.