pablaber / openapi-typescript-types

A library for generating Typescript types from an OpenAPI document.

openapi-typescript-types

A library for generating Typescript types from an OpenAPI document.

Usage

The script can either be run through the command line or with a config file.

Config File

The preferred way of running ott is by using a config file. If the config file is named ott.config.yaml and stored in the current working directory, the script can be invoked with that config file by running:

ott --config ./ott.config.yaml

Config File Structure

The structure and options for the config file are defined below:

version: 1.0               # The config version, only supports 1.0
input: ./swagger.yaml      # The path to teh swagger file input
output: ./out/types.ts     # The output file for the typescript types

options:                   # Additional options (optional)
  typeNameFormat: "{name}" # Format the name of output types.
  
  paths:                   # Options for paths, paths excluded if false
    include:               # List specific paths to include.
      - /pet/**            #   - Takes precedence over "exclude"
      - /store/**
    exclude:               # List specific paths to exclude
      - /user/**           #   - Has no effect if "include" is specified
  
  schemas:                 # Options for schemas, all schemas excluded if false
    include:               # List specific paths to include.
      - Pet                #   - Takes precedence over "exclude"
      - Category
    exclude:               # List specific paths to exclude
      - Customer           #   - Has no effect if "include" is specified

Command Line

The script can also be run through the command line, although the options are more limited than the config file.

You can always run ott --help for the most detailed and up to date explanation of the command line options.

Command Line Example

Below is an example of invoking the command to generate a types file without schemas that will be named petstore-types.ts from an input file of petstore.yaml.

ott \
  --input petstore.yaml \
  --output petstore-types.ts \
  --exclude-schemas

openapi-typescript-types's Issues

Add support for URL input

Add support for loading input OpenAPI document from a URL in addition to file paths

Add support for "nullable" fields

See "Null" section in https://swagger.io/docs/specification/data-models/data-types/

Support enum types

Instead of generic strings, enum strings can just be a list of the enum

Add request bodies to paths

Add support for oneOf, anyOf, and allOf

https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/

For the purposes of this ticket, we will treat oneOf and anyOf as the same. There are differences but it seems like a bit of overkill for now to get them to be different.

oneOf and anyOf would just use the union (|) while allOf would use the intersection (&)

Add logging

Add some more consistent logging. Using winston or some other logging library.

Add tests

Tests using jest or another testing framework

Also add linting / prettier

Require status checks to pass on testing and linting for merges

Initial Release

• figure out some CI stuff to make it easier to publish
• touch up readme before publish
• add license
• publish first package to npm under v0.1.0