armand-janssen/openapi-to-plantuml

This javascript tool creats s PlantUML Class Diagram from a OpenApi 3 specification

Development on openapi-to-plantuml is stopped since may 2019! It is migrated to https://github.com/armand-janssen/openapi-transformer

OpenAPI to PlantUML

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

Details

TODO

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