Skip to content

Generates TS typedefs and/or API client from swagger.json.

Notifications You must be signed in to change notification settings

Avalara/swagger-ts-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

swagger-ts-template

(quick n dirty script that) Generates a d.ts file containing the type definitions from a swagger .json file.

var generator = require('swagger-ts-template')
var source = require('api.json')

let output = generator.merge(source, {hideComments:true})
fs.writeFileSync('api.d.ts', output)

Full API client

The apigen branch also contains a full-fledged API consumer generator. Check it out!

Options

  • hideComments: If true, properties descriptions will not be included as comments in the generated file.

  • external: Formats the types as export type, making the file an external module.

CLI

This module may be installed globally and used as a command-line tool.

npm i swagger-ts-template --global
tstemplate <source> <dest> [-c] [-e]

About

Generates TS typedefs and/or API client from swagger.json.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published