gradle-springdoc-plugin

A gradle plugin to generate html rest api doc from spring mvc annotations.

License	MIT
Categories	Gradle Build Tools
GroupId	com.thilko.spring
ArtifactId	gradle-springdoc-plugin
Last Version	0.7
Release Date	Sep 9, 2014
Type	jar
Description	gradle-springdoc-plugin A gradle plugin to generate html rest api doc from spring mvc annotations.
Project URL	http://github.com/thilko/gradle-springdoc-plugin
Source Code Management	https://github.com/thilko/gradle-springdoc-plugin.git

Download gradle-springdoc-plugin

Filename	Size
gradle-springdoc-plugin-0.7.pom
gradle-springdoc-plugin-0.7.jar	138 KB
gradle-springdoc-plugin-0.7-sources.jar	7 KB
gradle-springdoc-plugin-0.7-javadoc.jar	261 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.thilko.spring/gradle-springdoc-plugin/ -->
<dependency>
    <groupId>com.thilko.spring</groupId>
    <artifactId>gradle-springdoc-plugin</artifactId>
    <version>0.7</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.thilko.spring/gradle-springdoc-plugin/
implementation 'com.thilko.spring:gradle-springdoc-plugin:0.7'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.thilko.spring/gradle-springdoc-plugin/
implementation ("com.thilko.spring:gradle-springdoc-plugin:0.7")

Apache Buildr

'com.thilko.spring:gradle-springdoc-plugin:jar:0.7'

Apache Ivy

<dependency org="com.thilko.spring" name="gradle-springdoc-plugin" rev="0.7">
  <artifact name="gradle-springdoc-plugin" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.thilko.spring', module='gradle-springdoc-plugin', version='0.7')
)

Scala SBT

libraryDependencies += "com.thilko.spring" % "gradle-springdoc-plugin" % "0.7"

Leiningen

[com.thilko.spring/gradle-springdoc-plugin "0.7"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.springframework : spring-webmvc	jar	4.0.0.RELEASE

test (1)

Group / Artifact	Type	Version
org.spockframework : spock-core	jar	0.7-groovy-1.8

Project Modules

There are no modules declared in this project.

gradle-springdoc-plugin

A gradle plugin to generate rest api documentation from spring mvc annotations at build time. No runtime dependencies.

Project is in an early development stage: ideas, issues and comments are highly appreciated.

Usage

Include the plugin in your gradle script:

buildscript {
    repositories {
      mavenCentral()
    }
    dependencies {
        classpath "com.thilko.spring:gradle-springdoc-plugin:0.7"
    }
}

apply plugin: 'springdoc'

You got a build task generateSpringDoc which produces HTML documentation in buildDir.

Have a look at the example.

Versions

Version
0.7 Sep 9, 2014
0.6.1 Jun 26, 2014
0.6 Jun 26, 2014
0.5 Jun 25, 2014
0.4 Jun 17, 2014
0.3.1 Jun 10, 2014
0.3 Jun 8, 2014
0.2.0 Feb 17, 2014
0.1.4 Jan 21, 2014
0.1.3 Jan 17, 2014
0.1.2 Jan 16, 2014
0.1.1 Jan 16, 2014
0.1 Jan 11, 2014