npmpackage.info

@pakholeung37/openapi-typescript-codegen

NodeJS library that generates Typescript or Javascript clients based on the OpenAPI specification

0.24.0

3,049

MIT

TypeScript

58.46 kB

356 4.2

Installations

npm install @pakholeung37/openapi-typescript-codegen

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.19.1

NPM Version

8.19.3 Score

68.4

Supply Chain

Quality

74.8

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

43

Total

1,798

Closed

346

Merged

1,409

Issues

Open

211

Total

487

Closed

276

Releases

v0.27.0

Published on 15 Jan 2024

v0.28.0

Published on 19 Mar 2024

v0.29.0

Published on 07 Apr 2024

v0.26.0

Published on 07 Jan 2024

v0.24.0

Published on 05 Jul 2023

v0.25.0

Published on 05 Jul 2023

View all 20 releases

Contributors

Unable to fetch Contributors

View all 51 contributors

Languages

TypeScript

Handlebars

JavaScript

HTML

Dockerfile

TypeScript (83.69%)

Handlebars (13.89%)

JavaScript (2.33%)

HTML (0.04%)

Dockerfile (0.04%)

Developer

ferdikoomen

Download Statistics

Total Downloads

356

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

3,049 Stars

2,711 Commits

532 Forks

15 Watching

6 Branches

51 Contributors

Bundle Size

306.56 kB

Minified

58.46 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

0.24.0

Package Id

@pakholeung37/openapi-typescript-codegen@0.24.0

Unpacked Size

225.02 kB

Size

33.24 kB

File Count

NPM Version

8.19.3

Node Version

16.19.1

Publised On

06 May 2023

Total Downloads

Cumulative downloads

Total Downloads

356

Last day

Compared to previous day

Last week

100%

Compared to previous week

Last month

900%

Compared to previous month

Last year

-82.5%

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

camelcase commander fs-extra handlebars json-schema-ref-parser

Dev Dependencies

Versions

OpenAPI Typescript Codegen

Node.js library that generates Typescript clients based on the OpenAPI specification.

Why?

Frontend ❤️ OpenAPI, but we do not want to use JAVA codegen in our builds
Quick, lightweight, robust and framework-agnostic 🚀
Supports generation of TypeScript clients
Supports generations of Fetch, Node-Fetch, Axios, Angular and XHR http clients
Supports OpenAPI specification v2.0 and v3.0
Supports JSON and YAML files for input
Supports generation through CLI, Node.js and NPX
Supports tsc and @babel/plugin-transform-typescript
Supports aborting of requests (cancelable promise pattern)
Supports external references using json-schema-ref-parser

Install

npm install openapi-typescript-codegen --save-dev

Usage

$ openapi --help

  Usage: openapi [options]

  Options:
    -V, --version             output the version number
    -i, --input <value>       OpenAPI specification, can be a path, url or string content (required)
    -o, --output <value>      Output directory (required)
    -c, --client <value>      HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
    --name <value>            Custom client class name
    --useOptions              Use options instead of arguments
    --useUnionTypes           Use union types instead of enums
    --exportCore <value>      Write core files to disk (default: true)
    --exportServices <value>  Write services to disk (default: true)
    --exportModels <value>    Write models to disk (default: true)
    --exportSchemas <value>   Write schemas to disk (default: false)
    --indent <value>          Indentation options [4, 2, tab] (default: "4")
    --postfixServices         Service name postfix (default: "Service")
    --postfixModels           Model name postfix
    --request <value>         Path to custom request file
    -h, --help                display help for command

  Examples
    $ openapi --input ./spec.json --output ./generated
    $ openapi --input ./spec.json --output ./generated --client xhr

Docker usage

To build the Docker container, execute the following command:

docker build . --tag openapi-typescript-codegen

After this is done, you can execute the CLI commands:

docker run openapi-typescript-codegen --help
docker run openapi-typescript-codegen --input sample.yaml --output client

Documentation

Basic usage
OpenAPI object
Client instances --name
Argument vs. Object style --useOptions
Enums vs. Union types --useUnionTypes
Runtime schemas --exportSchemas
Enum with custom names and descriptions
Nullable props (OpenAPI v2)
Authorization
External references
Canceling requests
Custom request file

Support

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

SAST

Determines if the project uses static code analysis.

6

Maintained

Determines if the project is "actively maintained".

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.2

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More