PlantUML supports mind maps, which are ideal for high-level API visualization.

https://plantuml.com/mindmap-diagram

Currently only anyOf is supported.

the date pattern dd-mm-yyyy is not allowed in json schema generator

use
^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$

OpenApi:

        myFancyName:
          $ref: '#/components/schemas/myType'

Plantuml:
Actual:

myFancyName: myFancyName

Expected:

myFancyName: myType

MD:
Actual:

| myFancyName|   | myFancyName|   |   |   |

Expected:

| myFancyName|   | myType|   |   |   |

I am having trouble installing. I have tried
npm install armand-janssen/openapi-transformer
and it seems to return with no errors, but openapi-transformer is not on my PATH.

Am I missing a step or is the problem with my npm install?

Limit the $ref depth – Crawling all of our $refs leads to a huge graph (and unusable diagrams), where maybe for the UML we only want a certain depth. So, allowing a limit on the depth of references.

Create a new transformer to create a JSON schema, which can be used in backend code to validate requests.

json schema rendered wrong, format should not be added when type is number

supporting alternate .yml extension

It will not follow a $ref that points to an html resource. Error is (company info removed)
UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, open './https://artifactory.cloud.mycompany.com/artifactory/maven/common-.yaml'
at Object.openSync (fs.js:498:3)
at Object.readFileSync (fs.js:394:35)
at loadYamlFile (C:\Users\212708371\AppData\Roaming\npm\node_modules\openapi-transformer\src\index.js:59:21)
at C:\Users\212708371\AppData\Roaming\npm\node_modules\openapi-transformer\src\index.js:78:47
at Array.forEach ()
at Object.loadYamlFile (C:\Users\212708371\AppData\Roaming\npm\node_modules\openapi-transformer\src\index.js:77:23)
at C:\Users\212708371\AppData\Roaming\npm\node_modules\openapi-transformer\src\cli.js:30:53
at Object. (C:\Users\212708371\AppData\Roaming\npm\node_modules\openapi-transformer\src\cli.js:56:5)
at Module._compile (internal/modules/cjs/loader.js:1072:14)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:1101:10)
(Use node --trace-warnings ... to show where the warning was created)
(node:36168) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag --unhandled-rejections=strict (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 2)
(node:36168) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

When rendering the json schema for an array the minItems are not rendered

The date time type is not allowed in json.

Pattern for: yyyy-MM-ddTHH:mm:ssZ ???

Currently all schema files must be in the same directory as where the software is executed.

#Allow for circular $refs – When resolving $refs it can lead to cycles, so only load files once

When PlantUML sees parenthesis, it assumes it is a method instead of a field.
You can prepend this file with {field} to override this.

OpenAPI Schema

components:
  schemas:
    someClass:
      type: Object
      properties:
        someField:
          type: string
          maxLength: 100
        problemField:
          type: string
          pattern: '^(NL|nl)([0-9]){5}$'
        someOtherField:
          type: string
          maxLength: 100

Generated PlantUML

@startuml
class someClass {
  someField : string [maxLength : 100]
  problemField : string [pattern : ^(NL|nl)([0-9]){5}$ ]
  someOtherField : string [maxLength : 100]
}

@enduml

Solution PlantUML

@startuml
class someClass {
  someField : string [maxLength : 100]
  {field} problemField : string [pattern : ^(NL|nl)([0-9]){5}$ ]
  someOtherField : string [maxLength : 100]
}
@enduml

On https://yaml-multiline.info/ more multiline characters than | are defined. Check with code if this is a problem in transforming.