Package Exports

openapi-transformer-toolkit
openapi-transformer-toolkit/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (openapi-transformer-toolkit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OpenAPI Codegen

Effortlessly automate your design-first API development workflow with an npm package that generates JSON schemas and TypeScript types from an OpenAPI specification.

Installation

First, install the package:

$ npm install openapi-transformer-toolkit

CLI

The package includes CLI commands for easier usage. Use the openapi-transformer-toolkit command followed by the subcommand and required options:

openapi-transformer-toolkit oas2json -i < input > -o < output >: Generate JSON schemas from an OpenAPI file
openapi-transformer-toolkit json2ts -i < input > -o < output > [-c < config >]: Generate TypeScript types from JSON schemas For example:

$ openapi-transformer-toolkit oas2json -i ./openapi.yml -o ./schemas

$ openapi-transformer-toolkit json2ts -i ./schemas -o ./types

Programmatic Usage

You can also use the package programmatically by importing the necessary functions:

import { oas2json, json2ts } from 'openapi-transformer-toolkit';

Generate JSON Schemas

To generate JSON schemas from your OpenAPI specification, provide the path to the OpenAPI file and the output directory for the generated schemas:

const openAPIPath = 'path/to/openapi.yml';
const schemasPath = 'path/to/output/schemas';
oas2json(openAPIPath, schemasPath);

Generate TypeScript Types

To generate TypeScript types from the generated JSON schemas, provide the path to the JSON schema directory and the output directory for the TypeScript types:

const schemasPath = 'path/to/output/schemas';
const tsTypesPath = 'path/to/output/types';
await json2ts(schemasPath, tsTypesPath);

Tests

Run the tests with:

$ npm test

Example

The example folder contains an example OpenAPI specification and the generated JSON schemas and TypeScript types. To generate the JSON schemas and TypeScript types from the example OpenAPI specification, run:

$ npm run oas2json

and then:

$ npm run json2ts

The generated JSON schemas and TypeScript types will be saved in the schemas and types folders respectively (example/output).