swagger-confluence-core

Core POM to upload Swagger to Confluence

License	Apache License 2.0
Categories	Swagger Program Interface REST Frameworks
GroupId	io.github.kicksolutions
ArtifactId	swagger-confluence-core
Last Version	1.0.2
Release Date	Jan 8, 2018
Type	jar
Description	swagger-confluence-core Core POM to upload Swagger to Confluence
Project Organization	Kick Solutions

Download swagger-confluence-core

Filename	Size
swagger-confluence-core-1.0.2.pom
swagger-confluence-core-1.0.2.jar	13 KB
swagger-confluence-core-1.0.2-sources.jar	8 KB
swagger-confluence-core-1.0.2-javadoc.jar	55 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.kicksolutions/swagger-confluence-core/ -->
<dependency>
    <groupId>io.github.kicksolutions</groupId>
    <artifactId>swagger-confluence-core</artifactId>
    <version>1.0.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.kicksolutions/swagger-confluence-core/
implementation 'io.github.kicksolutions:swagger-confluence-core:1.0.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.kicksolutions/swagger-confluence-core/
implementation ("io.github.kicksolutions:swagger-confluence-core:1.0.2")

Apache Buildr

'io.github.kicksolutions:swagger-confluence-core:jar:1.0.2'

Apache Ivy

<dependency org="io.github.kicksolutions" name="swagger-confluence-core" rev="1.0.2">
  <artifact name="swagger-confluence-core" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.kicksolutions', module='swagger-confluence-core', version='1.0.2')
)

Scala SBT

libraryDependencies += "io.github.kicksolutions" % "swagger-confluence-core" % "1.0.2"

Leiningen

[io.github.kicksolutions/swagger-confluence-core "1.0.2"]

Dependencies

compile (3)

Group / Artifact	Type	Version
io.swagger : swagger-parser	jar	1.0.33
org.springframework : spring-web	jar	4.3.7.RELEASE
com.jayway.jsonpath : json-path	jar	2.4.0

test (1)

Group / Artifact	Type	Version
junit : junit	jar	3.8.1

Project Modules

There are no modules declared in this project.

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

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.

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

Kick Solutions

Versions

Version
1.0.2 Jan 8, 2018
1.0.1 Jan 7, 2018
1.0.0 Dec 20, 2017
0.0.1-beta Dec 20, 2017
0.0.1-alpha Dec 20, 2017