gradle-springdoc-plugin

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

License

License

MIT
Categories

Categories

Gradle Build Tools
GroupId

GroupId

com.thilko.spring
ArtifactId

ArtifactId

gradle-springdoc-plugin
Last Version

Last Version

0.7
Release Date

Release Date

Type

Type

jar
Description

Description

gradle-springdoc-plugin
A gradle plugin to generate html rest api doc from spring mvc annotations.
Project URL

Project URL

http://github.com/thilko/gradle-springdoc-plugin
Source Code Management

Source Code Management

https://github.com/thilko/gradle-springdoc-plugin.git

Download gradle-springdoc-plugin

How to add to project

<!-- 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>
// https://jarcasting.com/artifacts/com.thilko.spring/gradle-springdoc-plugin/
implementation 'com.thilko.spring:gradle-springdoc-plugin:0.7'
// https://jarcasting.com/artifacts/com.thilko.spring/gradle-springdoc-plugin/
implementation ("com.thilko.spring:gradle-springdoc-plugin:0.7")
'com.thilko.spring:gradle-springdoc-plugin:jar:0.7'
<dependency org="com.thilko.spring" name="gradle-springdoc-plugin" rev="0.7">
  <artifact name="gradle-springdoc-plugin" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.thilko.spring', module='gradle-springdoc-plugin', version='0.7')
)
libraryDependencies += "com.thilko.spring" % "gradle-springdoc-plugin" % "0.7"
[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

Build Status

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
0.6.1
0.6
0.5
0.4
0.3.1
0.3
0.2.0
0.1.4
0.1.3
0.1.2
0.1.1
0.1