npmpackage.info

@protocolnebula/ts-openapi-generator

⚒ Generate API, Model, and Mocks files from Swagger/OpenAPI to use in any project (java, ts, js, PHP, angular...)

2.6.0

TypeScript

496.25 kB

Installations

npm install @protocolnebula/ts-openapi-generator

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.10.0

NPM Version

7.24.0 Score

35.2

Supply Chain

84.9

Quality

65.8

Maintenance

Vulnerability

92.8

License

Pull Requests

Open

20

Total

59

Closed

33

Merged

6

Issues

Open

13

Total

25

Closed

12

Releases

2.6.0

Updated on Aug 11, 2022

2.5.4

Updated on Feb 28, 2021

2.5.3

Updated on Feb 21, 2021

2.5.1

Updated on Feb 04, 2021

2.5.0

Updated on Jan 23, 2021

2.4.0

Updated on Jan 18, 2021

View All 18 releases

Contributors

Unable to fetch Contributors

View All 1 Contributors

Languages

TypeScript

JavaScript

Shell

TypeScript (97.02%)

JavaScript (2.53%)

Shell (0.45%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

ProtocolNebula

Download Statistics

Total Downloads

5,303

Last Day

Last Week

Last Month

Last Year

576

GitHub Statistics

9 Stars

139 Commits

2 Forks

3 Watchers

23 Branches

1 Contributors

Updated on Jul 09, 2024

Sponsor this package

https://patreon.com/ProtocolNebula

Maintainers

Package Meta Information

Latest Version

2.6.0

Package Id

@protocolnebula/ts-openapi-generator@2.6.0

Unpacked Size

496.25 kB

Size

190.32 kB

File Count

190

NPM Version

7.24.0

Node Version

16.10.0

Total Downloads

Cumulative downloads

Total Downloads

5,303

Last Day

Compared to previous day

Last Week

-16.7%

Compared to previous week

Last Month

-56.4%

Compared to previous month

Last Year

-33.3%

576

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@atao60/fse-cli api-spec-converter case casual fs-extra husky js-yaml mkdir-recursive mustache openapi-types swagger2openapi yargs

Dev Dependencies

@types/node @types/yargs copyfiles nodemon prettier pretty-quick rimraf ts-loader ts-node typescript webpack webpack-cli

TypeScript OpenApi/Swagger Generator

TypeScript OpenApi/Swagger Generator

Description :scroll:

This script is written in TypeScript, it can generate all Models and APIs (serivces) in any kind of language.

Currently it exports to Angular 2 but you can create your own templates (check templates folder).

You can modify those files to adapt to your code.

It's planned for a future to let configure this script instead need to modify the source code.

Installation :electric_plug:

1npm i @protocolnebula/ts-openapi-generator

You need to copy "ApiBase" which is the "dependences" to work. This will be changed in a future and will not be required to be copied. You can just download ApiBase folder and save in your project in the same folder that you will "output" the generated data or copy with this command.

1mkdir -p src/generatedApi
2cp -r node_modules/ts-openapi-generator/ApiBase src/generatedApi/ApiBase

Usage :hammer_and_pick:

The script

Is recommended to add a script to your package.json or package manager that you use.

Change src/generatedApi by your desired folder to generate the code. If you not specify mock-output, -o + mock/ will be used.

Note that -t (template) and --mock-engine are optional, you can only use some of them.

1transform-swagger \
2  -f URI/TO/SWAGGER/JSON/OR/YAML \
3  -o src/generatedApi/ \
4  -t angular2 \
5  --mock-engine json-server \
6  --mock-output path/to/mock

Config file :gear:

The settings of the config file are the same than cli one (but in camelCase).

Create the config file (you choose the name and the location)

We will use as example transfrom-config.json example's one.

1{
2  "clean": true,
3  "file": "./examples/openApiFiles/passportescaperoom.com.json",
4  "outputFolder": "./examples/generated/angular2",
5  "template": "angular2",
6  "mock-generator": "json-server",
7  "mock-output": "examples/generated/mocks/json-server",
8  "saveFile": "./openApiFiles/passportescaperoom.com"
9}

Launch the script

1transform-swagger --config-file ./examples/transform-config.json

Main CLI commands :open_book:

1Usage: transform-swagger [options]
2
3Options:
4  --version, -v        Show version number                             [boolean]
5  --config-file        Configuration file to use (values from cli will overwrite
6                       this file).
7  --mock-generator     Specify the generator to use to generate mocks. If none
8                       provider, mocks will not be generated
9  --mock-output        The path where mock will be generated. If no specified,
10                       output-folder/mock will be used
11  --mock-partial       If true, only mock data will be generated instead of all
12                       files                          [boolean] [default: false]
13  --clean              No clean the output-folder, so old files will remain
14                                                       [boolean] [default: true]
15  -f, --file           Path OR URL to the swagger document to parse   [required]
16  -o, --output-folder  Specify the output folder (generated folders will be
17                       replaced)                             [default: "output"]
18  -t, --template       Template (preset) name or path to a template
19  -h, --help           Show help                                       [boolean]
20  -s, --save-file                                    [default: "./openapi_temp"]
21
22Examples:
23  cli -f swagger.js -o api/ -t angular2  Convert a Swagger JSON file to
24                                         compatible-angular API

Supported generators :toolbox:

API/Models

Plugin name refers to the template parameter (-t or --template in the cli)

Language/Framework	Status	Plugin name (-t)
Angular 2	Beta	`angular2`

Mock engine

Generator name refers to the mock-generator parameter (--mock-generator in the cli)

Engine	Status	Generator name (--mock-generator)
json-server	Beta	`json-server`

Development :memo:

Run with watch (internet file)

This will generate a file in output/temp.json|yaml

npm run start:dev -- -f URL_TO_SWAGGER.JSON/YAML

Run with watch (local file)

You can re-use the downloaded file or specify another folder

npm run start:dev -- -f output/temp.json -o src/generatedApi/ -t angular2

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.

7

SAST

Determines if the project uses static code analysis.

1

Pinned-Dependencies

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

0

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

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

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

40 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-h452-7996-h45h
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-pppg-cpfq-h7wr
Warn: Project is vulnerable to: GHSA-hw8r-x6gr-5gjp
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
Warn: Project is vulnerable to: GHSA-5mjw-6jrh-hvfq
Warn: Project is vulnerable to: GHSA-x9hc-rw35-f44h
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq
Warn: Project is vulnerable to: GHSA-qgmg-gppg-76g5
Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

3

/10

Last Scanned on 2025-02-24

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