JarCasting
JarCasting JarCasting

com.github.ci-cd:gradle-swagger-plugin

This gradle plugin is used to generate docs for Rest APIs that can be used with swagger-ui. This plugin is equivalent to com.github.kongchen:swagger-maven-plugin

License

License
Categories

Categories

Gradle Build Tools Swagger Program Interface REST Frameworks
GroupId

GroupId

com.github.ci-cd
ArtifactId

ArtifactId

gradle-swagger-plugin
Last Version

Last Version

1.0
Release Date

Release Date
Type

Type

jar
Description

Description

com.github.ci-cd:gradle-swagger-plugin
This gradle plugin is used to generate docs for Rest APIs that can be used with swagger-ui. This plugin is equivalent to com.github.kongchen:swagger-maven-plugin
Project URL

Project URL

https://github.com/ci-cd/gradle-swagger-plugin
Source Code Management

Source Code Management

https://github.com/ci-cd/gradle-swagger-plugin

Download gradle-swagger-plugin

Filename Size
gradle-swagger-plugin-1.0.pom
gradle-swagger-plugin-1.0.jar 56 KB
gradle-swagger-plugin-1.0-sources.jar 25 KB
gradle-swagger-plugin-1.0-javadoc.jar 99 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.ci-cd/gradle-swagger-plugin/ -->
<dependency>
    <groupId>com.github.ci-cd</groupId>
    <artifactId>gradle-swagger-plugin</artifactId>
    <version>1.0</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.ci-cd/gradle-swagger-plugin/
implementation 'com.github.ci-cd:gradle-swagger-plugin:1.0'
// https://jarcasting.com/artifacts/com.github.ci-cd/gradle-swagger-plugin/
implementation ("com.github.ci-cd:gradle-swagger-plugin:1.0")
'com.github.ci-cd:gradle-swagger-plugin:jar:1.0'
<dependency org="com.github.ci-cd" name="gradle-swagger-plugin" rev="1.0">
  <artifact name="gradle-swagger-plugin" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.ci-cd', module='gradle-swagger-plugin', version='1.0')
)
libraryDependencies += "com.github.ci-cd" % "gradle-swagger-plugin" % "1.0"
[com.github.ci-cd/gradle-swagger-plugin "1.0"]

Dependencies

compile (10)

Group / Artifact Type Version
commons-io : commons-io jar 2.0.1
ch.qos.logback : logback-classic jar 1.0.13
org.apache.httpcomponents : httpclient jar 4.2.2
org.reflections : reflections jar 0.9.9-RC1
com.github.spullara.mustache.java : compiler jar 0.8.12
com.wordnik : swagger-jaxrs_2.10 jar 1.3.2
org.slf4j : slf4j-api jar 1.7.2
com.wordnik : swagger-jersey-jaxrs_2.10 jar 1.3.2
javax.ws.rs : javax.ws.rs-api jar 2.0
org.apache.commons : commons-lang3 jar 3.1

test (1)

Group / Artifact Type Version
junit : junit jar 4.11

Project Modules

There are no modules declared in this project.

gradle-swagger-plugin

This project is forked from dave-ellis/gradle-swagger-plugin. (See https://github.com/dave-ellis/gradle-swagger-plugin)

Usage

Gradle

    buildscript {
        repositories {
            mavenLocal()
            maven { url "http://repo.maven.apache.org/maven2" }
        }
        dependencies {
            classpath group: 'com.github.ci-cd', name: 'gradle-swagger-plugin', version: '1.0'
        }
    }

    apply plugin: 'maven'
    apply plugin: 'swagger'
    apply plugin: 'java'
    
    dependencies {
    	compile group: 'com.wordnik', name: 'swagger-annotations', version: '1.3.10'
    	...
    }
    
    swagger {
        endPoints = [
                'com.foo.bar.apis',
                'com.foo.bar.apis.internal.Resource'
        ]
        apiVersion = version
        basePath = 'http://www.example.com/rest'
        swaggerUIDocBasePath = '/swagger-ui/rest-api-docs'
        swaggerDirectory = "${buildDir}/site/api-docs"
    }
  • The swagger block currently only allows the definition of one apiSource.
  • Java classes containing Swagger's annotation @Api, or Java packages containing those classes can be configured in endPoints list.
  • Note: Works only with swagger-annotations artifact from com.wordnik group ID.
  • outputTemplate is the path of the mustache template file.
  • outputPath is the path of your output file, not existed parent directory of the file will be created.
  • If swaggerDirectory is configured, the plugin will also generate a Swagger resource listing suitable for feeding to swagger-ui.
    • useOutputFlatStructure indicates whether swagger output will be created in sub-directories by path defined in @com.wordnik.swagger.annotations.Api#value (false), or the filename will be the path with replaced slashes to underscores (true). Default: true
com.github.ci-cd

Continuous Integration - Continuous Delivery

Versions

Version
1.0