api-spec-converter/lib/formats/api_blueprint.js

Convert API descriptions between popular formats such as OpenAPI(fka Swagger), RAML, API Blueprint, WADL, etc.

'use strict';

var _ = require('lodash');
var Promise = require('bluebird');
var Drafter = require('drafter.js');
var Inherits = require('util').inherits;
var BPToSwagger = require('apib2swagger');

var BaseFormat = require('../base_format.js');

var APIBlueprint = module.exports = function() {
  APIBlueprint.super_.apply(this, arguments);
  this.format = 'api_blueprint';

  this.converters.swagger_2 = Promise.method(apibp => {
    return BPToSwagger.convertParsed(apibp.spec, {});
  });

  this.converters.openapi_3 =
    Promise.method(apibp => this.convertTransitive(['swagger_2', 'openapi_3']));
}

Inherits(APIBlueprint, BaseFormat);

APIBlueprint.prototype.formatName = 'apiBlueprint';
APIBlueprint.prototype.supportedVersions = ['1A'];
APIBlueprint.prototype.getFormatVersion = function () {
  return _(this.spec.metadata).filter({name: 'FORMAT'})
    .get('[0].value', '1A');
}

APIBlueprint.prototype.parsers = {
  'APIB': Promise.method(data => Drafter.parse(data, {type: 'ast'}).ast)
};

APIBlueprint.prototype.checkFormat = function (spec) {
  //TODO: 'spec.ast' isn't working find other criteria.
  return true;
}