simple-swagger-codegen v0.9.0

Simple Swagger Codegen

Swagger Tools + Mustache codegen, simply renders a provided mustache template against a swagger swagger definition.

TODO

• add tests

Installation

Download/clone this repo for now using curl, git or your favorite github client app. Requires Node.js version 10.0 or higher. Use nvm to easily switch between different versions of node runtimes.

Usage

const fs = require('fs');
const codegen = require('./lib/codegen');
const swaggerDoc = require('./swagger.json');

const template = fs.readFileSync('./templates/classGenerator.mustache', 'utf-8');

codegen.processSwagger(swaggerDoc, imports).then((swagger) => {
  let code = codegen.renderTemplate(template, swagger);
  fs.writeFileSync('./controller.js', code);
});

Example

Run example with the command node example.js

Options

processSwagger(...) accepts one argument: a swagger document parsed into a JSON object. You can do this

  swagger:
    type: object
    required: true
    description: a json swagger document
  imports:
    type: array
    required: false
    description: optional data structure for node.js module imports
  customParams:
    type: object
    required: false
    description: optional variables to add to the object passed to mustache

renderTemplate({...}) accepts the following parameters:

  swagger:
    type: object
    required: true
    description: any json object, intended to be the formatted swagger object from processSwagger()
  template:
    type: object
    required: true
    description: a .mustache template

Template Variables

The following data are passed to the mustache templates:

domain:
  type: string
  description: If all options defined: swagger.schemes[0] + '://' + swagger.host + swagger.basePath
securityDefinitions:
  type: array
  items:
    type: object
    properties:
      name:
        type: string
      type:
        type: string
      authorizationUrl:
        type: string
      flow:
        type: string
      scopes:
        type: object
definitions:
  type: array
  items:
    type: object
    properties:
      name:
        type: string
      type:
        type: string
      properties:
        type: object
operations:
  type: array
  items:
    type: object
    properties:
      summary:
        type: string
      description:
        type: string
      operationId:
        type: string
      path:
        type: string
      method:
        type: string
      tags:
        type: array
        items:
          type: string
      consumes:
        type: array
        items:
          type: string
      produces:
        type: array
        items:
          type: string
      parameters:
        type: array
        items:
          type: object
          properties:
            in:
              type: string
            name:
              type: string
            description:
              type: string
            required:
              type: boolean
            schema:
              type: object
                $ref:
                  type: string
        responses:
          type: object
        security:
          type: array
          items:
            type: object

Custom Mustache Parameters

You can also pass in your own parameters for the mustache templates by adding a customParams object:

var source = codegen.processSwagger({
    ...
    customParams: {
      foo: 'bar',
      app_build_id: env.BUILD_ID,
      app_version: pkg.version
    }
});