Giter VIP home page Giter VIP logo

apiary_blueprint_convertor's Introduction

logo

Apiary Blueprint AST Convertor Build Status

A migration tool for legacy Apiary Blueprint AST into API Blueprint AST. Converts Apiary Blueprint AST serialized into a JSON file to API Blueprint AST JSON representation (vnd.apiblueprint.ast.raw+json; version=2.0).

NOTE: This library is deprecated in favour of fury and the Fury API Blueprint Serializer.

Installation

Add this line to your application's Gemfile:

gem 'apiary_blueprint_convertor'

And then execute:

$ bundle

Or install it yourself as:

$ gem install apiary_blueprint_convertor

Usage

$ apiary_blueprint_convertor path/to/legacy/ast.json

See the convert feature for details or run apiary_blueprint_convertor --help.

Convert Legacy Apiary Blueprint to API Blueprint

Use this convertor together with the legacy Apiary Blueprint Parser and API Blueprint Composer โ€“ Matter Compiler.

  1. Parse Legacy Apiary Blueprint into its JSON AST using Apiary Blueprint Parser
  2. Convert legacy JSON AST into API Blueprint JSON AST using apiary_blueprint_convertor
  3. Compose API Blueprint from API Blueprint JSON AST using matter_compiler

For example:

$ blueprint-parser legacy_blueprint.apib | apiary_blueprint_convertor | matter_compiler --format json > new_blueprint.md

Contributing

  1. Fork this repository (http://github.com/apiaryio/apiary_blueprint_convertor/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

MIT License. See the LICENSE file.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.