OpenapiAutomatons

What OpenapiAutomatons

This library is a generator using openapi file.

Requirements

Since v2 this package is ESM-only and requires Node.js >= 22. Use it from an ESM project (or import it dynamically). v1.x (CommonJS) remains available for older setups.

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

2. Create settings in your project root automatons.json

{
  "openapi": "openapi.yml",
  "automatons": [{
    "automaton": "@automatons/typescript-client-axios",
    "outDir": "src/clients"
  }]
}

3. 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. |