openapi-transformer
Transforms OpenAPI Schemas to other formats like MarkDown and PlantUML
Last updated 7 days ago by armand-janssen .
GPL-3.0 · Original npm · Tarball · package.json
$ cnpm install openapi-transformer 
SYNC missed versions from official npm registry.

OpenAPI transformer

Coverage Status

Build Status

Known Vulnerabilities

This tool creates a PlantUML Class Diagram or Markdown (Optimized for Showdown) from a OpenApi 3 Yaml specification

Requirements

  • OpenAPI 3.0.2
  • OpenAPI specification should be in YAML
  • NodeJS

Usage

Always run the script from the directory in which the yaml file are.

Usage: index [options] <inputfile>

Options:
  -V, --version                       Output the version number
  -p, --plantuml <plantuml file>      The plantuml file
  -m, --markdown <markdown file>      The output file for markdown
  -j, --jsonschema <jsonschema file>  Transform to json schema
  -v, --verbose                       Show verbose debug output
  -h, --help                          Output usage information

Example

Generates to plantuml

openapi-transformer vehicle.yaml --plantuml vehicle.plantuml

Generates to plantuml with verbose debug info :)

openapi-transformer vehicle.yaml --verbose --plantuml vehicle.plantuml

Generates to plantuml file and markdown file

openapi-transformer vehicle.yaml --plantuml ./example.plantuml --markdown ./example.md

Example output plantuml

No details

Example no details

Details

Example with details

Online utils

Current Tags

  • 0.6.0                                ...           latest (7 days ago)

15 Versions

  • 0.6.0                                ...           7 days ago
  • 0.5.4                                ...           8 months ago
  • 0.5.3                                ...           8 months ago
  • 0.5.2                                ...           8 months ago
  • 0.5.1                                ...           8 months ago
  • 0.5.0                                ...           10 months ago
  • 0.4.2                                ...           a year ago
  • 0.4.1                                ...           a year ago
  • 0.4.0                                ...           a year ago
  • 0.3.2                                ...           a year ago
  • 0.3.1                                ...           a year ago
  • 0.3.0                                ...           a year ago
  • 0.2.1                                ...           a year ago
  • 0.2.0                                ...           a year ago
  • 0.1.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 32
Last Day 1
Last Week 12
Last Month 14
Dependencies (5)
Dev Dependencies (9)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |