thilko / gradle-springdoc-plugin

Generate api documentation from mvc spring annotations
MIT License
10 stars 1 forks source link

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.