npmpackage.info

Gathering detailed insights and metrics for swagger-vue-generator

Other packages similar to swagger-vue-generator

orval

7.5.0

A swagger client generator for typescript

swagger-vue-codegen

0.15.11

A swagger client uses axios and typescript

swagger-to-vue

1.0.3

Simple library for generating Vue services from a Swagger/OpenAPI yaml/json definition file.

@kubb/plugin-vue-query

3.5.7

Generator vue-query hooks

swagger-vue-generator

Generate documentation for swagger-vue with templates (markdown or html)

1.0.6

MIT

CSS

95.17 kB

126,967 3

Installations

npm install swagger-vue-generator

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

6.12.1

NPM Version

3.10.10 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

CSS

JavaScript

HTML

CSS (93.76%)

JavaScript (5.88%)

HTML (0.36%)

Developer

sonrac

Download Statistics

Total Downloads

126,967

Last Day

Last Week

Last Month

Last Year

1,405

GitHub Statistics

13 Stars

22 Commits

6 Forks

2 Watching

1 Branches

1 Contributors

Bundle Size

339.00 kB

Minified

95.17 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.6

Package Id

swagger-vue-generator@1.0.6

Size

726.13 kB

NPM Version

3.10.10

Node Version

6.12.1

Total Downloads

Cumulative downloads

Total Downloads

126,967

Last day

Compared to previous day

Last week

-33.3%

Compared to previous week

Last month

82.5%

Compared to previous month

Last year

-69.7%

1,405

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

argparse chai child_process fs lodash path swagger-vue yaml

Dev Dependencies

coveralls ink-docstrap istanbul jasmine-node jsdoc mocha

Versions

Swagger vue documentation & api front generator

Install

1npm install --save-dev swagger-vue-generator

Generate api:

Use script node_modules/swagger-vue-generator/bin/generate-api.js

Arguments description

Argument	Alias	Description	Notes
`-h`	`--help`	Show this help message and exit.	[optional]
`-v`	`--version`	Show this help message and exit.	[optional]
`-f`	`--flag-swagger`	Set swagger version (`2.0` or `openapi`). 2.0 only supported	[optional]. Default value is `2.0`
`-s`	`--source`	Source swagger file destination.	required
`-m`	`--moduleName`	Swagger generator module name.	required
`-c`	`--className`	Swagger generator class name.	[optional]. Default value is API
`-d`	`--destination`	Destination for output generate client.	required

Example usages

1node ./node_modules/swagger-vue-generator/bin/generate-api.js -s /path/to/api-docs.json -d /path/to/api.js -m module-name

Generate README.MD for api

Arguments description

Argument	Alias	Description	Notes
`-h`	`--help`	Show this help message and exit.	[optional]
`-v`	`--version`	Show this help message and exit.	[optional]
`-s`	`--source`	Source swagger file destination.	required
`-f`	`--flag-swagger`	Set swagger version (`2.0` or `openapi`). 2.0 only supported	[optional]. Default value is `2.0`
`-m`	`--moduleName`	Swagger generator module name.	required
`-c`	`--className`	Swagger generator class name.	[optional]. Default value is API
`-t`	`--template`	Template dir.	[optional]. Default value is `./node_modules/swagger-vue-generator/src/2.0/templates/markdown`
`-d`	`--destination`	Destination for output generate client.	required
	`--model-path`	Destination for models.	[optional]
	`--doc-path`	Destination for methods.	[optional]

Custom templates

Change template path with option -t or --template. Copy origin template from ./node_modules/swagger-vue-generator/src/2.0/templates/markdown and change it

Example usages

Generate doc

node ./node_modules/swagger-vue-generator/bin/generate-doc.js -s ../path/to/api-docs.json -d /path/to/destination -m module-name --model-path=models --doc-path=methods

Generate api

node ./node_modules/swagger-vue-generator/bin/generate-api.js -s ../path/to/api-docs.json -d /path/to/destination -m module-name

Run tests

Install dev dependencies

1npm install --dev

Run test

1npm run test

No vulnerabilities found.

10

Binary-Artifacts

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

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

Code-Review

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

0

CII-Best-Practices

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

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

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

Score

3

/10

Last Scanned on 2025-01-27

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