zir01 / swag-ts-ng

Swagger client Typescript Codegen Angularjs

swag-ts-ng

Swagger client Typescript Codegen for Angularjs

Please note this is still Work in progress (experimental)

Install

$npm install swag-ts-ng

Usage

var swag = require('swag-ts-ng');

var options = {
    swaggerPath: "URL for your swagger definition", // required
    interfaceDestination: "API/Interfaces",         // optional
    classDestination: "API/Model",                  // optional
    modelModuleName: "Model",                       // optional
    clientDestination: "API/Service",               // optional
    clientModuleName: "Service",                    // optional
    clientClassName: "ApiDataService",              // optional
    singleFile: false                               // optional
}

swag.process(options);

Building

To transpile typescript to js, run:

$ npm run build ###Options

Field name	Default	Description
swaggerPath	none (required)	URL of the Swagger document
interfaceDestination	API/[Title from Swagger]	Path for the interfaces
classDestination	none	If empty or missing, classes will not be generated
modelModuleName	API.[Title from Swagger]	Module name for the interfaces
clientDestination	API/[Title from Swagger]	Path for the client
clientModuleName	none	Module name for the client class
clientClassName	[Title from Swagger]Client	Class name for the client
singleFile	false	Put all the generated code in a single file

swag-ts-ng's Issues

postCreator fails if the method doesn't have any parameters