Installation

npm install swagger-typescript-codegen

Example

varfs=require("fs");varCodeGen=require("swagger-typescript-codegen").CodeGen;varfile="swagger/spec.json";varswagger=JSON.parse(fs.readFileSync(file,"UTF-8"));vartsSourceCode=CodeGen.getTypescriptCode({className:"Test",swagger:swagger,imports:["../../typings/tsd.d.ts"]});console.log(tsSourceCode);

Custom template

varsource=CodeGen.getCustomCode({moduleName:"Test",className:"Test",swagger:swaggerSpec,template:{class:fs.readFileSync("my-class.mustache","utf-8"),method:fs.readFileSync("my-method.mustache","utf-8"),type:fs.readFileSync("my-type.mustache","utf-8")}});

Options

template: { class: "...", method: "..." }

moduleName:type:stringdescription:Your module nameclassName:type:stringbeautify:type:booleandescription:whether or not to beautify the generated codebeautifyOptions:type:objectdescription:Options to be passed to the beautify command. See js-beautify for all available options.mustache:type:objectdescription:See the 'Custom Mustache Variables' section belowimports:type:arraydescription:Typescript definition files to be imported.convertQueryParamsToFormDataInPOST:type:booleandescription:whether or not to convert query parameters in a POST request to form data.swagger:type:objectrequired:truedescription:swagger object

Template Variables

isES6:type:booleandescription:type:stringdescription:Provided by your options field: 'swagger.info.description'isSecure:type:booleandescription:false unless 'swagger.securityDefinitions' is definedmoduleName:type:stringdescription:Your module name - provided by your options fieldclassName:type:stringdescription:Provided by your options fielddomain:type:stringdescription:If all options defined: swagger.schemes[0] + '://' + swagger.host + swagger.basePathmethods:type:arrayitems:type:objectproperties:path:type:stringpathFormatString:type:stringclassName:type:stringdescription:Provided by your options fieldmethodName:type:stringdescription:Generated from the HTTP method and path elements or 'x-swagger-js-method-name' fieldmethod:type:stringdescription:'GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'COPY', 'HEAD', 'OPTIONS', 'LINK', 'UNLINK', 'PURGE', 'LOCK', 'UNLOCK', 'PROPFIND'enum:        -GET        -POST        -PUT        -DELETE        -PATCH        -COPY        -HEAD        -OPTIONS        -LINK        -UNLINK        -PURGE        -LOCK        -UNLOCK        -PROPFINDisGET:type:stringdescription:true if method === 'GET'summary:type:stringdescription:Provided by the 'description' or 'summary' field in the schemaexternalDocs:type:objectproperties:url:type:stringdescription:The URL for the target documentation. Value MUST be in the format of a URL.required:truedescription:type:stringdescription:A short description of the target documentation. GitHub-Markdown syntax can be used for rich text representation.isSecure:type:booleandescription:true if the 'security' is defined for the method in the schemaversion:type:stringdescription:Version part of the path, if the path starts with the prefix '/api/vXXX/'.intVersion:type:integerdescription:Integer part of the version string.isLatestVersion:type:booleandescription:True iff this is the latest version of the method.parameters:type:arraydescription:Includes all of the properties defined for the parameter in the schema plus:items:camelCaseName:type:stringisSingleton:type:booleandescription:true if there was only one 'enum' defined for the parametersingleton:type:stringdescription:the one and only 'enum' defined for the parameter (if there is only one)isBodyParameter:type:booleanisPathParameter:type:booleanisQueryParameter:type:booleanisPatternType:type:booleandescription:true if *in* is 'query', and 'pattern' is definedisHeaderParameter:type:booleanisFormParameter:type:booleancollectionFormat:type:stringsuccessfulResponseType:type:stringdescription:The type of a successful response. Defaults to any for non-parsable types or Swagger 1.0 spec filessuccessfulResponseTypeIsRef:type:booleandescription:True iff the successful response type is the name of a type defined in the Swagger schema.convertQueryParamsToFormDataInPOST:type:booleandescription:Provided by your options field

Custom Mustache Variables

varsource=CodeGen.getCustomCode({    ...mustache:{foo:'bar',app_build_id:env.BUILD_ID,app_version:pkg.version}});

Swagger Extensions

x-proxy-header

/locations:get:parameters:      -name:X-AppEngine-Countryin:headerx-proxy-header:truetype:stringdescription:Provided by AppEngine eg - US, AU, GB      -name:countryin:querytype:stringdescription:|          2 character country code.          If not specified, will default to the country provided in the X-AppEngine-Country header...

Development

npm run build:watch

npm run test:watch