Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Swagger to Puml convertion tool helps to generate Class Diagrams from Swagger Definition.

This Project is based on Maven and plan to support Gradle also in future.
Following are modules we currently have
Following are modules we currently have

- swagger2puml-core
- swagger2puml-maven
Expand All @@ -29,7 +29,7 @@ Create a new System Variable called GRAPHVIZ_DOT and point to dot.exe for window
- Once the swagger.puml gets generated sucessfully it then calls [Plant UML] to generate swagger.svg


## swagger2puml-core:
## swagger2puml-core:

This utility takes Swagger Yaml as input and as response it generates swagger.puml and swagger.svg files as output.

Expand All @@ -38,10 +38,16 @@ To see the generated PUML file, please click [here](examples/swagger.puml)

![Swagger-Class-Diagram-Sample](examples/swagger.svg)

### Usage:
### Building

```
java -cp swagger2puml.jar com.kicksolutions.swagger.Swagger2PlantUML [options]
mvn package
```

### Usage

```
java -jar swagger2puml.jar [options]

-i {Path of Swagger Definition (Can be either Yaml or json)}
-o {Target location where Puml File and Image should generated}
Expand Down
27 changes: 27 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,33 @@
<check />
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<mainClass>com.kicksolutions.swagger.Swagger2PlantUML</mainClass>
</manifest>
</archive>
<outputDirectory>${project.parent.basedir}</outputDirectory>
<finalName>swagger2puml</finalName>
<appendAssemblyId>false</appendAssemblyId>
</configuration>
<executions>
<execution>
<id>assemble-all</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

Expand Down