JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4268
  • Score
    100M100P100Q124273F
  • License MIT

Convert OpenAPI format to Markdown

Package Exports

  • openapi-to-md

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (openapi-to-md) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

openapi-to-md src-file [dist-file]

openapi-to-md openapi.yaml README.md
openapi-to-md openapi.json > README.md