Skip to content

Generate TypeScript typings based on an OpenAPI schema object.

Notifications You must be signed in to change notification settings

ifroz/openapi-to-typescript

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

openapi-to-typescript

NPM version Build Status Greenkeeper badge semantic-release

Generate TypeScript typings based on az OpenAPI3 schema definition.

Install

Run npm install openapi-to-typescript or yarn add openapi-to-typescript

Usage in javascript

const { GenerateTypings } = require('openapi-to-typescript')

const generatedTypescriptCode = await GenerateTypings(openapiSchema)
fs.writeFileSync('out.ts', generatedTypescriptCode)

CLI Usage

yarn cli --help

For development

const { GenerateTypings } = require('./dist/index')

GenerateTypings(require('./fixtures/petstore.json')).then((generatedTypescriptCode: string) => {
  fs.writeFileSync('out.ts', generatedTypescriptCode)
})

About

Generate TypeScript typings based on an OpenAPI schema object.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •