https://github.com/kicksolutions/swagger2confluence

This will upload the Swagger document to Confluence Page
https://github.com/kicksolutions/swagger2confluence

confluence swagger

Last synced: 6 months ago
JSON representation

This will upload the Swagger document to Confluence Page

• Host: GitHub
• URL: https://github.com/kicksolutions/swagger2confluence
• Owner: kicksolutions
• License: apache-2.0
• Created: 2017-12-19T07:37:44.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-01-09T15:44:07.000Z (over 8 years ago)
• Last Synced: 2025-07-14T01:18:34.694Z (12 months ago)
• Topics: confluence, swagger
• Language: Java
• Size: 286 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/kicksolutions/swagger2confluence.svg?branch=master)](https://travis-ci.org/kicksolutions/swagger2confluence)

[![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~swagger-confluence-core~~~)

# Swagger2Confluence

Swagger to Confluence tool helps to publish Swagger Definitions to Confluence Page.

This Project is based on Maven and plan to support Gradle also in future.

Following are modules we currently have 

- swagger2confluence-core

- swagger2confluence-maven

Following are the tools which this project internally uses:

- [Swagger Parser]

- [Confluence REST Services]

# How does it work

- Swagger2Confluence internally reads the swagger definition using [Swagger Parser] which then uploads to confluence page

based on the attributes provided.

It will first Create Page whose Title = Title of API Specified in Swagger then creates child under it with Version-Title of API

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

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

## swagger2confluence-core: 

This utility takes Swagger Yaml as input and as response it uploads to Confluence Page.

Below is the Sample Confluence Page Output which gets imported.

![Swagger-Confluence-Upload-Sample](examples/swagger.jpg)

### Usage:

```

java -cp swagger2confluence.jar com.kicksolutions.swagger.confluence.Swagger2Confluence [options]

-i {Path of Swagger Definition (Can be either Yaml or json)}

-a {Parent Page Id of Confluence}

-u {User Name}

-p {password}

-l {Confluence REST URL}

-s {Confluence Space key}

-r {URL of Swagger from Maven} (Optional)

-c {Generated Clientkit URL/Generate Clientkit URL of Swagger Online} (Optional)

-d {Generated HTML documentation of Swagger} (Optional)

```

## swagger2confluence-maven

This Maven plugin is Mojo, which internally calls swagger2confluence-core to upload Swagger Definition.

Swagger Definition can be either yaml or json extensions.

License

----

Apacahe 2.0

[Swagger]: 

[Swagger Parser]: 

[Confluence REST Services]: