Gathering detailed insights and metrics for @acos/swagger-markdown
Gathering detailed insights and metrics for @acos/swagger-markdown
Installations
npm install @acos/swagger-markdownDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
16.17.1
NPM Version
8.15.0
Score
71.7
Supply Chain
90.8
Quality
74.9
Maintenance
100
Vulnerability
99.6
License
Releases
38
Languages
3
TypeScript
JavaScript
Shell
TypeScript (96.4%)
JavaScript (3.41%)
Shell (0.19%)
Developer
syroegkin
Download Statistics
Total Downloads
6,316
Last Day
2
Last Week
63
Last Month
364
Last Year
3,667
GitHub Statistics
MIT License
248 Stars
510 Commits
87 Forks
5 Watchers
3 Branches
13 Contributors
Updated on Jun 20, 2025
Bundle Size
437.35 kB
Minified
122.34 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
1.0.1
Package Id
@acos/swagger-markdown@1.0.1
Unpacked Size
49.06 kB
Size
13.76 kB
File Count
52
NPM Version
8.15.0
Node Version
16.17.1
Total Downloads
Cumulative downloads
Total Downloads
6,316
Last Day
0%
2
Compared to previous day
Last Week
-33.7%
63
Compared to previous week
Last Month
-13.5%
364
Compared to previous month
Last Year
90.2%
3,667
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
28
@commitlint/cli@commitlint/config-conventional@semantic-release/changelog@semantic-release/commit-analyzer@semantic-release/git@semantic-release/github@semantic-release/npm@semantic-release/release-notes-generator@types/argparse@types/chai@types/jest@types/node@typescript-eslint/eslint-plugin@typescript-eslint/parserchaicommitizencz-conventional-changelogeslinteslint-config-airbnb-baseeslint-plugin-importhuskyjestlint-stagedmarkdownlint-clisemantic-releasets-jestts-nodetypescript
swagger-markdown
To Do: Write a new documentations
CLI script to turn swagger yaml into markdown files. Supports swagger 2.0 format only
see examples folder
Installation
1npm install -g swagger-markdown
Usage
swagger-markdown [-h] [-v] -i [-o] [--skip-info]
Options:
-h, --help Show this help message and exit.
-v, --version Show program's version number and exit.
-i , --input Path to the swagger yaml file
-o , --output Path to the resulting md file
--skip-info Skip the title, description, version etc, whatever is in the info block.
Npx (requires no installation)
1npx swagger-markdown -i ./basic-auth.yaml
Example
1swagger-markdown -i path/to/swagger/file.yaml
By default it will create the new file within the same directory with the same name as swagger file but with .md extension.
So, if swagger file is placed in project/api-doc/swagger.yaml the new file will be created as project/api-doc/swagger.md
You can also use it as a npm script in your package.json:
1npm i --save-dev swagger-markdown
1{ 2 "scripts": { 3 "md-docs": "swagger-markdown -i path/to/swagger.yaml", 4 //... 5 } 6}
1npm run md-docs
Related
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
SAST tool is not run on all commits -- score normalized to 3
Details
- Warn: 10 commits out of 28 are checked with a SAST tool
Reason
8 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/8 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
2.6
/10
Last Scanned on 2025-06-23
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