openapi-automatons
TypeScript icon, indicating that this package has built-in type declarations

1.0.259 • Public • Published

OpenapiAutomatons

CI/CD codecov semantic-release npm downloads

What OpenapiAutomatons

This library is a generator using openapi file.

What code can generate?

name language type
@automatons/typescript-client-axios typescript client

Get Started

  1. Install library to your project
yarn add -D openapi-automatons @automatons/typescript-client-axios
  1. Create settings in your project root automatons.json
{
  "openapi": "openapi.yml",
  "automatons": [{
    "automaton": "@automatons/typescript-client-axios",
    "outDir": "src/clients"
  }]
}
  1. Add generate command your package.json
{
  "scripts": {
    "generate": "openapi-automatons"
  }
}

Automatons.json

property type required description
openapi string true This is openapi path. It can be relative or absolute. Also, there is no problem with the url format.
automatons array true This is the property that contains the module.
automatons automaton string true This is the module name. You can embed your own module. It is also possible to include it with a relative path.
automatons outDir string true This is the output directory of module.

Readme

Keywords

Package Sidebar

Install

npm i openapi-automatons

Weekly Downloads

2

Version

1.0.259

License

MIT

Unpacked Size

14.7 kB

Total Files

23

Last publish

Collaborators

  • tanmen