npmpackage.info

markdown-swagger

Generate API docs from Swagger file into markdown file.

1.0.4

MIT

JavaScript

4.95 kB

62,082 2.3

Installations

npm install markdown-swagger

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

10.8.0

NPM Version

6.4.1 Score

50.2

Supply Chain

67.8

Quality

Maintenance

Vulnerability

99.6

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

3

Total

5

Closed

2

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

JavaScript

JavaScript (100%)

Developer

rmariuzzo

Download Statistics

Total Downloads

62,082

Last Day

Last Week

Last Month

299

Last Year

4,032

GitHub Statistics

72 Stars

17 Commits

12 Forks

3 Watching

2 Branches

1 Contributors

Maintainers

Package Meta Information

Latest Version

1.0.4

Package Id

markdown-swagger@1.0.4

Unpacked Size

4.95 kB

Size

2.38 kB

File Count

NPM Version

6.4.1

Node Version

10.8.0

Total Downloads

Cumulative downloads

Total Downloads

62,082

Last day

Compared to previous day

Last week

-62.5%

Compared to previous week

Last month

-18.5%

299

Compared to previous month

Last year

-33.5%

4,032

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

chalk-printer columnify fs-extra js-yaml meow xml-comment-api

Versions

Markdown Swagger

Generate API docs from Swagger file into markdown file.

Installation

1npm install markdown-swagger

Usage

1markdown-swagger ./api/swagger/swagger.yaml ./README.md

This will read the specified swagger file and generate a table describing the API inside the target markdown file.

The markdown-swagger script will look for the for the following piece of text inside the target markdown file to do its stuff:

1<!-- markdown-swagger -->
2  Everything here will be replaced by markdown-swagger
3<!-- /markdown-swagger -->

No vulnerabilities found.

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.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

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

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

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

Score

2.3

/10

Last Scanned on 2024-12-16

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

Other packages similar to markdown-swagger

swagger-markdown

2.3.2

Create markdown API documentation from swagger file

@acos/swagger-markdown

1.0.1

Create markdown API documentation from swagger file

swagger-to-markdown

0.3.1

convert swagger to markdown

postgres-markdown

1.3.6

Builds Slate compatible markdown from a Postgres connection