@implydata/openapi-typescript-codegen
TypeScript icon, indicating that this package has built-in type declarations

0.22.1 • Public • Published

OpenAPI Typescript Codegen

NPM License Coverage Quality Code Climate Downloads Build

Node.js library that generates Typescript clients based on the OpenAPI specification.

Why?

  • Frontend ❤️ OpenAPI, but we do not want to use JAVA codegen in our builds
  • Quick, lightweight, robust and framework-agnostic 🚀
  • Supports generation of TypeScript clients
  • Supports generations of Fetch, Node-Fetch, Axios, Angular and XHR http clients
  • Supports OpenAPI specification v2.0 and v3.0
  • Supports JSON and YAML files for input
  • Supports generation through CLI, Node.js and NPX
  • Supports tsc and @babel/plugin-transform-typescript
  • Supports aborting of requests (cancelable promise pattern)
  • Supports external references using json-schema-ref-parser

Install

npm install openapi-typescript-codegen --save-dev

Usage

$ openapi --help

  Usage: openapi [options]

  Options:
    -V, --version             output the version number
    -i, --input <value>       OpenAPI specification, can be a path, url or string content (required)
    -o, --output <value>      Output directory (required)
    -c, --client <value>      HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
    --name <value>            Custom client class name
    --useOptions              Use options instead of arguments
    --useUnionTypes           Use union types instead of enums
    --exportCore <value>      Write core files to disk (default: true)
    --exportServices <value>  Write services to disk (default: true)
    --exportModels <value>    Write models to disk (default: true)
    --exportSchemas <value>   Write schemas to disk (default: false)
    --indent <value>          Indentation options [4, 2, tab] (default: "4")
    --postfix <value>         Service name postfix (default: "Service")
    --request <value>         Path to custom request file
    -h, --help                display help for command

  Examples
    $ openapi --input ./spec.json --output ./generated
    $ openapi --input ./spec.json --output ./generated --client xhr

Documentation

Support

Package Sidebar

Install

npm i @implydata/openapi-typescript-codegen

Weekly Downloads

2

Version

0.22.1

License

MIT

Unpacked Size

208 kB

Total Files

7

Last publish

Collaborators

  • imply-sailathayellapantula
  • kgyrtkirk
  • craig.skinfill-imply.io
  • adithyachakilam
  • andrew.rabini
  • suneet-s-imply
  • vladimir.filipchanka
  • zach.sherman
  • daryl.guieb
  • mnolan-imply
  • visheshimply
  • hannahyun90
  • pranavbhole
  • akhilamukka
  • dloftus-imply
  • vtlim
  • will.brantley
  • abhishek-radhakrishnan
  • findingrish
  • jonah-rankin
  • margaretcbrewster
  • tsfenwick
  • imply-elliott
  • neha-ellur
  • amaechler
  • cryptoe
  • kishorepai
  • jwilsonimply
  • adarsh.sanjeev
  • qsss
  • pei.xing
  • benschuiling-imply
  • lakshsingla
  • implyadmin
  • vadimon
  • lorem--ipsum
  • ofir
  • andreacyc
  • kyhtsang
  • davidgee
  • wylieallen-i
  • rob.jenkins
  • dclim
  • roughlycorrect
  • implyjw
  • apeck
  • andy.tsai
  • cemclaug
  • jgoz
  • abhishekagarwal.iitr
  • georgew5656
  • hazzelnut
  • imply-ddoroshenko
  • celineechangg
  • implybot
  • dkoepke
  • arunramani_imply
  • agarboos
  • rmn7-imply
  • teddyty
  • starking192