openapi-to-plantuml

Converts OpenAPI 3 components to PlantUml or Markdown

DEPRECATED please use openapi-transformer
$ cnpm install openapi-to-plantuml 
SYNC missed versions from official npm registry.

OpenAPI to PlantUML

Coverage Status

Build Status

This tool creates a PlantUML Class Diagram from a OpenApi 3 Yaml specification

Requirements

  • OpenAPI 3.0.2
  • OpenAPI specification should be in YAML
  • NodeJS
  • All yaml files should be in 1 directory

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 <output file>     The output file for markdown
  -v, --verbose                    Show verbose debug output
  -h, --help                       Output usage information

Example

**Prints to plantuml **

openapi-to-plantuml vehicle.yaml --plantuml vehicle.plantuml

Prints to plantuml with verbose debug info :)

openapi-to-plantuml vehicle.yaml --verbose --plantuml vehicle.plantuml

Prints to plantuml file and markdown file

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

Example output plantuml

No details

Example no details

Details

Example with details

TODO

  • refactor / cleanup code
  • test loading the openapi yaml, instead of the vehicle.yaml
  • add OpenAPI version validation

Current Tags

  • 1.0.3                                ...           latest (a year ago)

4 Versions

  • 1.0.3 [deprecated]           ...           a year ago
  • 1.0.2 [deprecated]           ...           a year ago
  • 1.0.1 [deprecated]           ...           a year ago
  • 1.0.0 [deprecated]           ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 4
Dependencies (3)
Dev Dependencies (9)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |