loopback-swagger/lib/codegen/generator-v1.2.js

Integration between LoopBack and Swagger API specs

// Copyright IBM Corp. 2015,2019. All Rights Reserved.
// Node module: loopback-swagger
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT

'use strict';

var assert = require('assert');
var util = require('util');
var base = require('./generator-base');

function V12Generator(options) {
  base.BaseGenerator.apply(this, arguments);
}

util.inherits(V12Generator, base.BaseGenerator);

function V12Operation(op) {
  base.BaseOperation.apply(this, arguments);
}

util.inherits(V12Operation, base.BaseOperation);

V12Operation.prototype.resolveTypeRef = function(ref) {
  if (typeof ref === 'string') {
    if (ref.indexOf('#/models/') === 0) {
      ref = ref.substring('#/models/'.length);
    }
  }
  return ref;
};
/**
 * Convert a swagger parameter to strong-remoting argument
 * @param {Object} p
 * @returns {Object}
 */
V12Operation.prototype.parameter = function(p) {
  var type = p.type;
  if (p.type === 'integer') {
    type = 'number';
  }
  if (p.type === 'array' && p.items) {
    type = [p.items.type || this.resolveTypeRef(p.items.$ref)];
  }
  if (p.schema && p.schema.$ref) {
    type = this.resolveTypeRef(p.schema.$ref);
  }
  return {
    arg: p.name,
    type: type || 'any',
    description: p.description,
    required: p.required,
    http: {
      source: p.paramType,
    },
  };
};

V12Operation.prototype.getReturns = function() {
  if (this.returns) {
    return this.returns;
  }
  var returns = [
  ];

  var type = this.type;
  if (this.type === 'integer') {
    type = 'number';
  }
  if (this.type === 'array' && this.items) {
    type = [this.items.type || this.resolveTypeRef(this.items.$ref)];
  }
  if (this.type && this.type !== 'void') {
    returns.push({
      description: this.description || this.notes,
      type: type || 'any',
      arg: 'data',
      root: true,
    });
  }
  this.errorTypes = [];
  this.returnType = type || 'any';
  if (this.responseMessages) {
    for (var i = 0, n = this.responseMessages.length; i < n; i++) {
      var res = this.responseMessages[i];

      this.errorTypes.push({
        statusCode: res.code,
        message: res.message,
      });
    }
  }
  this.returns = returns;
  return this.returns;
};

V12Generator.prototype.getOperations = function(spec) {
  assert(spec && spec.swaggerVersion === '1.2');
  // var resourcePath = spec.resourcePath;
  // var basePath = spec.basePath;
  spec.models = spec.models || {};
  var models = spec.models;

  var operations = {};
  for (var i = 0, n = spec.apis.length; i < n; i++) {
    var api = spec.apis[i];
    var path = api.path;

    for (var j = 0, k = api.operations.length; j < k; j++) {
      var op = api.operations[j];

      if (!op.parameters) {
        op.parameters = [];
      }

      op.consumes = op.consumes || spec.consumes;
      op.produces = op.produces || spec.produces;

      op.operationId = op.nickname;
      op.models = models;

      op.description = op.summary || op.notes;

      // Replace {id} with :id
      op.path = path.replace(/{(([^{}])+)}/g, ':$1');
      op.verb = op.method && op.method.toLowerCase();

      var operation = new V12Operation(op);
      operation.getRemoting();

      operations[operation.path] = operations[operation.path] || {};
      operations[operation.path][operation.verb] = operation;
    }
  }
  return operations;
};

module.exports = V12Generator;