Git Product home page Git Product logo

openapi-transformer's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.