swagger-confluence-core

Core POM to upload Swagger to Confluence

Лицензия

Лицензия

Категории

Категории

Swagger Межпрограммное взаимодействие REST Frameworks
Группа

Группа

io.github.kicksolutions
Идентификатор

Идентификатор

swagger-confluence-core
Последняя версия

Последняя версия

1.0.2
Дата

Дата

Тип

Тип

jar
Описание

Описание

swagger-confluence-core
Core POM to upload Swagger to Confluence
Организация-разработчик

Организация-разработчик

Kick Solutions

Скачать swagger-confluence-core

Как подключить последнюю версию

<!-- 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>
// https://jarcasting.com/artifacts/io.github.kicksolutions/swagger-confluence-core/
implementation 'io.github.kicksolutions:swagger-confluence-core:1.0.2'
// https://jarcasting.com/artifacts/io.github.kicksolutions/swagger-confluence-core/
implementation ("io.github.kicksolutions:swagger-confluence-core:1.0.2")
'io.github.kicksolutions:swagger-confluence-core:jar:1.0.2'
<dependency org="io.github.kicksolutions" name="swagger-confluence-core" rev="1.0.2">
  <artifact name="swagger-confluence-core" type="jar" />
</dependency>
@Grapes(
@Grab(group='io.github.kicksolutions', module='swagger-confluence-core', version='1.0.2')
)
libraryDependencies += "io.github.kicksolutions" % "swagger-confluence-core" % "1.0.2"
[io.github.kicksolutions/swagger-confluence-core "1.0.2"]

Зависимости

compile (3)

Идентификатор библиотеки Тип Версия
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)

Идентификатор библиотеки Тип Версия
junit : junit jar 3.8.1

Модули Проекта

Данный проект не имеет модулей.

Build Status Maven Central

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:

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

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

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

io.github.kicksolutions

Kick Solutions

Версии библиотеки

Версия
1.0.2
1.0.1
1.0.0
0.0.1-beta
0.0.1-alpha