Cody2333 / dtsgenerator

TypeScript d.ts file generate from JSON Schema file

dtsgenerator

TypeScript d.ts file generator from JSON Schema file or OpenAPI(Swagger) spec file.

Table of Contents

• Install
• Usage
• Advance Usage
• Development
• ChangeLog
• License

Install

npm install -g dtsgenerator

• Releases

Usage

$ dtsgen --help
Usage: script [options] <file ... | file patterns using node-glob>

Options:

  -V, --version                output the version number
  --url <url>                  input json schema from the url. (default: )
  --stdin                      read stdin with other files or urls.
  -o, --out <file>             output d.ts filename.
  -n, --namespace <namespace>  use root namespace instead of definitions or components.schema from OpenAPI, or -n "" to suppress namespaces.
  -h, --help                   output usage information

  Examples:

    $ dtsgen --help
    $ dtsgen --out types.d.ts schema/**/*.schema.json
    $ cat schema1.json | dtsgen
    $ dtsgen -o swaggerSchema.d.ts --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/schemas/v2.0/schema.json
    $ dtsgen -o petstore.d.ts -n PetStore --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/petstore.yaml

Use HTTP/HTTPS Proxy

If you need a proxy to fetch the schema, please set the following environment variables.

export http_proxy=http://proxy.example.com:8080/
export https_proxy=http://proxy.example.com:8080/
# If there are exceptionally hosts that do not go through a proxy
export no_proxy=google.com, yahoo.com

Advance Usage

For customize the output type name.

Install for library

npm install -S dtsgenerator

Usage for library

For example, it want to add the I prefix to the interface name. This is not usual example...

https://github.com/horiuchi/dtsgenerator/blob/master/example/add-prefix/index.ts

import dtsGenerator, { DefaultTypeNameConvertor, SchemaId } from 'dtsgenerator';
import * as fs from 'fs';

const filePath = '../../test/snapshots/json-schema-draft-04/schema/schema.json';

function typeNameConvertor(id: SchemaId): string[] {
    const names = DefaultTypeNameConvertor(id);
    if (names.length > 0) {
        const lastIndex = names.length - 1;
        names[lastIndex] = 'I' + names[lastIndex];
    }
    return names;
}

async function main(): Promise<void> {
    const content = JSON.parse( fs.readFileSync(filePath, 'utf-8') );
    const result = await dtsGenerator({
        contents: [content],
        typeNameConvertor,
    });
    console.log(result);
}
main();

Development

Debug

Output debug message by debug library.

$ DEBUG=dtsgen dtsgen schema/news.json

Links about JSON Schema and Swagger

• The home of JSON Schema
• The OpenAPI Specification

Supported spec and features

• JSON Schema

  • Draft-04 and before
  • Draft-07 and before

• OpenAPI

  • OpenAPI Specification version 2.0
  • OpenAPI Specification version 3.0

• supported features in these spec

ChangeLog

v2.6.0 (2020-05-14)

• features:
  • Support nested schema 'allOf' keywords, And added support for accessing the remote schema through a proxy by #405. Thank you @Brian-Kavanagh 👍

v2.5.1 (2020-04-27)

• fixed:
  • Fix: the bug of name conversion by #402. Thank you @unclechu 👍
  • Fix: Error when spaces included in a 'name' property under paths/parameters by #407. Thank you @scvnathan 👍

v2.5.0 (2020-02-28)

• features:
  • Add to support the text media type on Open API Schema by #396. Thank you @silesky 👍

v2.4.1 (2020-02-05)

• fixed
  • Fix: the bug of #386. thank you for reporting issue @Oloompa 👍

v2.4.0 (2020-02-04)

• fixed
  • Fix: typescript import statement #381. thank you @lupus92 👍
  • Fix: use export when given empty namespace #386. Thank you @zregvart 👍

older versions history

ChangeLogs

License

dtsgenerator is licensed under the MIT license.

Copyright © 2016-2020, Hiroki Horiuchi