kicksolutions / swagger2puml Goto Github PK

View Code? Open in Web Editor NEW

47.0 5.0 20.0 102 KB

Generate Class Diagrams (UML) for Given Swagger Definition

License: Apache License 2.0

Java 97.72% HTML 2.28%

uml-class-diagram swagger2 swagger-codegen plantuml graphviz swagger-parser uml uml-diagrams uml-diagram uml-model

swagger2puml's People

Contributors

Stargazers

Watchers

Forkers

colugo kolisko dgileadi jorgefdt casperbang enjoywl siyb chinmayj daf182 darrenc bartoszm seralf pushitio xpomul prochemo vinayasathyanarayana sleroy marissaatilano258 raphiki

swagger2puml's Issues

Usage detail

Hello,

I tried using your tool, but found the documentation to be a bit unclear on how to do so. Here's what I did:

cloned the repo
did a mvn clean install

But I can't find the swagger2puml.jar that is mentioned in the docs.

What am I missing ?

Thanks a lot for your help :)

All the best;

Dockerfile

A Dockerfile would allow running the application without the need to install Java locally on e.g. a Mac computer for one diagram.

Create swagger2puml core module

It's called OpenAPI 😅

Howdy! I found this thing Goolging and it looks awesome. I want to put it on openapi.tools but wanted to point out: the specification has not been called Swagger for a long time.

The name of the specification is OpenAPI, and tools should probably use that in their name instead of Swagger, as that's just the name of the official set of tools (Swagger Codegen, Swagger UI, Swagger Editor).

Maybe rename to openapi2puml, and make the description "Generate Class Diagrams (UML) for Given OpenAPI (f.k.a Swagger) Definition" so it still shows up on Google for both searches.

NPE when using multilevel inheritance

When processing a yaml with definitions that include multiple levels of inheritance an NPE is thrown.

Example model:
`

  GrandParentObj:
    discriminator: objType
    required:
      - objType
    properties:
      prop1:
        type: string
      objType:
        type: string

  ParentObj:
    allOf:
      - $ref: '#/definitions/GrandParentObj'
      - type: object
        properties:
          prop2:
            type: string
        
  ChildObj1:
    allOf:
      - $ref: '#/definitions/ParentObj'
      - type: object
        properties:
          prop3:
            type: string`

NPE Stacktrace:
`

Caused by: java.lang.NullPointerException
    at java.util.HashMap.putMapEntries (HashMap.java:501)
    at java.util.HashMap.putAll (HashMap.java:785)
    at com.kicksolutions.swagger.plantuml.PlantUMLCodegen.getClassMembers (PlantUMLCodegen.java:745)
    at com.kicksolutions.swagger.plantuml.PlantUMLCodegen.getClassMembers (PlantUMLCodegen.java:693)
    at com.kicksolutions.swagger.plantuml.PlantUMLCodegen.processSwaggerModels (PlantUMLCodegen.java:577)
    at com.kicksolutions.swagger.plantuml.PlantUMLCodegen.preprocessSwagger (PlantUMLCodegen.java:120)
    at com.kicksolutions.swagger.plantuml.PlantUMLCodegen.generatePuml (PlantUMLCodegen.java:83)
    at com.kicksolutions.swagger.plantuml.PlantUMLGenerator.transformSwagger2Puml (PlantUMLGenerator.java:43)
    at com.kicksolutions.swagger.Swagger2PlantUML.process (Swagger2PlantUML.java:71)
    at com.kicksolutions.swagger.Swagger2PlantUML.init (Swagger2PlantUML.java:55)
    at com.kicksolutions.swagger.Swagger2PlantUML.main (Swagger2PlantUML.java:37)`

It looks like when the getClassMembers(ComposedModel) method loops over the "AllOf" list of the target model to resolve the parent model's properties, that if the parent is itself the child of another type that it's getProperties() method returns null, causing the NPE when we try to put them into the child's Map of properties.

I'm attaching a patch with a proposed fix.

There is a secondary issue, also addressed in the patch, which is that even with the NPE fixed the code wasn't correctly resolving the full list of properties from the descendant types.

In the example above, the UML generated for "ChildObj1" looked like:
`

class ChildObj1 {
- prop3 :String
}`

With the patch applied we recurse to get properties from the descendants, and the output includes prop1 & prop2 from the parent & grandparent types:
`

class ChildObj1 {
- prop3 :String
- prop2:String
- prop1:String
}`

kicksolutions / swagger2puml Goto Github PK

swagger2puml's People

Contributors

Stargazers

Watchers

Forkers

swagger2puml's Issues

inheritance support?

Usage detail

Dockerfile

Create swagger2puml core module

It's called OpenAPI 😅

NPE when using multilevel inheritance

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent