An open API service indexing awesome lists of open source software.

https://github.com/kicksolutions/puml2confluence

Uploads Plant UML Diagrams to Confluence
https://github.com/kicksolutions/puml2confluence

classdiagram confluence plantuml uml uml-class-diagram

Last synced: 6 months ago
JSON representation

Uploads Plant UML Diagrams to Confluence

Awesome Lists containing this project

README

          

[![Build Status](https://travis-ci.org/kicksolutions/puml2confluence.svg?branch=master)](https://travis-ci.org/kicksolutions/puml2confluence)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.swagger/swagger-codegen-project/badge.svg?style=plastic)](https://oss.sonatype.org/#nexus-search;gav~io.github.kicksolutions~puml-confluence-core~~~)

# puml2Confluence

Plant UML to Confluence tool helps to publish Plant UML diagrams to Confluence Page.

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

- plantuml2confluence-core
- plantuml2confluence-maven

Following are the tools which this project internally uses:

- [Swagger Parser]
- [Confluence REST Services]

# How does it work

- puml2Confluence internally reads the swagger definition using [Swagger Parser] which then uploads to confluence page
based on the attributes provided.

Following is example

![Swagger-Confluence-Root](examples/root.jpg)

Confluence Page Uses Plant Macro, this will help us to see full view of Plant UML inside Confluence

## puml2confluence-core:

This utility takes Plant UML as input and as response it uploads to Confluence Page.

Below is the Sample Confluence Page Output which gets imported.
![PlantUML-Confluence-Upload-Sample](examples/swagger.jpg)

### Usage:

```
java -cp puml2confluence.jar com.kicksolutions.confluence.Puml2Confluence [options]

-i {Path of Puml}
-a {Parent Page Id of Confluence}
-u {User Name}
-p {password}
-l {Confluence REST URL}
-s {Confluence Space key}
-t {Title of Page}

```

## swagger2confluence-maven

This Maven plugin is Mojo, which internally calls puml2confluence-core to upload Plant UML Definition.

License
----

Apacahe 2.0

[Swagger]:
[Swagger Parser]:
[Confluence REST Services]: