npmpackage.info

Gathering detailed insights and metrics for openapi-to-md

Other packages similar to openapi-to-md

openapi-transformer

0.11.0

Transforms OpenAPI Schemas to other formats like MarkDown and PlantUML

@mugi111/swagger-md

0.1.0

OpenApi json to markdown

Gathering detailed insights and metrics for openapi-to-md

openapi-to-md - 1.0.25 | npmpackage.info

openapi-to-md

1.0.25

JavaScript

108.65 kB

242,629 3.2

Installations

npm install openapi-to-md

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.11.1

NPM Version

9.7.2 Pull Requests

Open

1

Total

3

Closed

0

Merged

2

Issues

Open

4

Total

4

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

TypeScript

JavaScript (95.42%)

TypeScript (4.58%)

Developer

SoraKumo001

Download Statistics

Total Downloads

242,629

Last Day

558

Last Week

2,240

Last Month

14,918

Last Year

201,004

GitHub Statistics

11 Stars

22 Commits

5 Forks

1 Watchers

3 Branches

2 Contributors

Updated on May 07, 2025

Bundle Size

376.27 kB

Minified

108.65 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

1.0.25

Package Id

openapi-to-md@1.0.25

Unpacked Size

53.11 kB

Size

12.45 kB

File Count

NPM Version

9.7.2

Node Version

20.11.1

Published on

Dec 14, 2024

Total Downloads

Cumulative downloads

Total Downloads

242,629

Last Day

-0.4%

558

Compared to previous day

Last Week

-58.5%

2,240

Compared to previous week

Last Month

2.4%

14,918

Compared to previous month

Last Year

609.4%

201,004

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

commander swagger2openapi yaml

Dev Dependencies

@types/node @types/swagger2openapi @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-import-resolver-typescript eslint-plugin-import openapi-types prettier ts-node typescript typescript-eslint

openapi-to-md

description

OpenAPI(v2,v3) => Markdown

It supports 'v2' and 'v3' formats of OpenAPI.
You can use 'json' and 'yaml' as input files.
The output data structure is in TypeScript format.
The reference does not resolve the second reference because it avoids recursion.

usage

Usage: openapi-to-md [options] <source> [destination]

Options:
  -V, --version  output the version number
  -s, --sort     sort (default: false)
  -h, --help     display help for command

1openapi-to-md -s openapi.yaml README.md
2openapi-to-md openapi.yaml README.md
3openapi-to-md openapi.json > README.md
4openapi-to-md https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.yaml README.md

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Code-Review

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

0

Pinned-Dependencies

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

0

Token-Permissions

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

0

Maintained

Determines if the project is "actively maintained".

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

License

Determines if the project has defined a license.

0

Branch-Protection

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

0

SAST

Determines if the project uses static code analysis.

Score

3.2

/10

Last Scanned on 2025-05-05

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