Grokola Swagger Maven Plugin

Sonatype helps open source projects to set up Maven repositories on https://oss.sonatype.org/

License	MIT License
Categories	Maven Build Tools KeY Data Data Formats Formal Verification Swagger Program Interface REST Frameworks
GroupId	com.keyholesoftware
ArtifactId	khs-grokola-swagger-maven-plugin
Last Version	1.0
Release Date	May 18, 2016
Type	maven-plugin
Description	Grokola Swagger Maven Plugin Sonatype helps open source projects to set up Maven repositories on https://oss.sonatype.org/
Source Code Management	https://github.com/in-the-keyhole/khs-grokola-swagger-maven-plugin

Download khs-grokola-swagger-maven-plugin

Filename	Size
khs-grokola-swagger-maven-plugin-1.0.pom
khs-grokola-swagger-maven-plugin-1.0.jar	7 KB
khs-grokola-swagger-maven-plugin-1.0-sources.jar	3 KB
khs-grokola-swagger-maven-plugin-1.0-javadoc.jar	36 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.keyholesoftware</groupId>
    <artifactId>khs-grokola-swagger-maven-plugin</artifactId>
    <version>1.0</version>
</plugin>

Dependencies

compile (2)

Group / Artifact	Type	Version
org.apache.maven : maven-plugin-api	jar	3.0
commons-io : commons-io	jar	2.4

provided (1)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.4

test (1)

Group / Artifact	Type	Version
junit : junit	jar	3.8.1

Project Modules

There are no modules declared in this project.

grokola-swagger-plugin

GrokOla Swagger Integration Maven Plugin

Overview

The Grokola Swagger Integration Maven Plugin can be used with Maven projects to upload Swagger JSON files describing the project's API to Grokola via the Maven build life-cycle.

Getting Started

Add this plugin to the build/plugins section of your API project's pom.xml like so:

<plugin>
	<groupId>com.khs</groupId>
	<artifactId>khs-grokola-swagger-maven-plugin</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<configuration>			
		<grokolaBaseUrl>https://beta.grokola.com</grokolaBaseUrl>
		<grokolaCategory>Miscellaneous</grokolaCategory>
		<grokolaAuthToken>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</grokolaAuthToken>
		<swaggerJsonFile>src/main/resources/static/swagger.json</swaggerJsonFile>
	</configuration>
	<executions>
		<execution>
			<phase>install</phase>
			<goals>
				<goal>grokola-swagger-upload</goal>
			</goals>
		</execution>
	</executions>
</plugin>

In the configuration section, specify the following settings:

Setting	Description	required/optional	Default value
grokolaBaseUrl	the URL of the Grokola instance	optional	https://beta.grokola.com
grokolaCategory	the category name in Grokola	optional	Miscellaneous
grokolaAuthToken	the auth token from Grokola	required
swaggerJsonFile	the file path of the Swagger JSON file	required

In the executions section of the plugin, specify a Maven build life-cycle phase and a goal of grokola-swagger-upload. In this example, we used the install phase but you might prefer to used something else, like deploy.

Keyhole Software

Software dev team providing consulting, development & education services with Java, JavaScript & .NET technologies.

Versions

Version
1.0 May 18, 2016