Package Exports

swagger-node-codegen
swagger-node-codegen/lib/codegen

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (swagger-node-codegen) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Swagger ES6 Node.js code generator

Description

Use your API Swagger definition to generate the Node.js ES6-compliant code of your API.

The generated code features:

ES6
Gulp
Makefile
ESLint
YAML config file
Express

How to use it?

If you want to use the CLI to generate your APIs please check swagger-node-codegen-cli

npm install swagger-node-codegen

Now, in your app:

var path = require('path');
var generator = require('swagger-node-codegen');
var your_api = require('./your-api.json');

generator.generate({
  swagger: your_api,
  target_dir: path.resolve(__dirname, './your-api')
}, function (err) {
  if (err) return console.error('Something went wrong:', err.message);
  console.log('Done!');
});

or using ES6:

import path from 'path';
import generator from 'swagger-node-codegen';
import your_api from './your-api.json';

generator.generate({
  swagger: your_api,
  target_dir: path.resolve(__dirname, './your-api')
}, (err) => {
  if (err) return console.error(`Something went wrong: ${err.message}`);
  console.log('Done!');
});

The swagger parameter can be either JSON or a path pointing to a JSON or YAML file.

import path from 'path';
import generator from 'swagger-node-codegen';

generator.generate({
  swagger: path.resolve(__dirname, './your-api.yml'),
  target_dir: path.resolve(__dirname, './your-api')
}, (err) => {
  if (err) return console.error(`Something went wrong: ${err.message}`);
  console.log('Done!');
});

Author

Francisco Méndez Vilas (fmvilas@gmail.com)

www.fmvilas.com

This project was heavily inspired by Swagger JS Codegen made by William Candillon.