Spring-REST-Doc Maven Plugin

Maven plugin that generates the documentation of REST APIs that are based on Spring MVC and JAXB.

License	MIT License
GroupId	com.apporiented
ArtifactId	spring-rest-doc-plugin
Last Version	1.6.1
Release Date	Sep 5, 2016
Type	maven-plugin
Description	Spring-REST-Doc Maven Plugin Maven plugin that generates the documentation of REST APIs that are based on Spring MVC and JAXB.
Project Organization	Lars Behnke
Source Code Management	https://github.com/lbehnke/spring-rest-doc-plugin

Download spring-rest-doc-plugin

Filename	Size
spring-rest-doc-plugin-1.6.1.pom
spring-rest-doc-plugin-1.6.1.jar	11 KB
spring-rest-doc-plugin-1.6.1-sources.jar	6 KB
spring-rest-doc-plugin-1.6.1-javadoc.jar	38 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.apporiented</groupId>
    <artifactId>spring-rest-doc-plugin</artifactId>
    <version>1.6.1</version>
</plugin>

Dependencies

compile (8)

Group / Artifact	Type	Version
com.apporiented : spring-rest-doc	jar	1.6.1
com.fasterxml.jackson.core : jackson-databind	jar	2.4.5
com.fasterxml.jackson.core : jackson-annotations	jar	2.4.5
com.fasterxml.jackson.module : jackson-module-jaxb-annotations	jar	2.4.5
com.google.guava : guava	jar	18.0
org.apache.maven : maven-core	jar	3.0
org.apache.maven : maven-plugin-api	jar	3.0
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.2

Project Modules

There are no modules declared in this project.

spring-rest-doc-plugin

Maven 3 plugin that creates an API documentation as JSON or XML document.

Usage:

    <plugin>
        <groupId>com.apporiented</groupId>
        <artifactId>spring-rest-doc-plugin</artifactId>
        <configuration>
            <apiBaseUrl>http://localhost:8080/api</apiBaseUrl>
            <apiVersion>${project.version}</apiVersion>
            <apiPackages>
                <!-- Comma separated list of packes that contain DTOs and REST controllers -->
                <!-- Optionally, the apidoc modules describes itself -->
                com.apporiented.rest.apidoc.model
            </apiPackages>
            <apiFormat>JSON</apiFormat>
            <apiFile>${project.build.directory}/mbtht-api.json</apiFile>
            <!--
            <apiFormat>XML</apiFormat>
            <apiFile>${project.build.directory}/apidoc.xml</apiFile>
            -->
        </configuration>
        <dependencies>
            <!-- Dependencies that contain DTOs and REST controller classes go here! -->
        </dependencies>
    </plugin>

Versions

Version
1.6.1 Sep 5, 2016
1.6 Dec 2, 2015
1.5 Nov 5, 2015
1.4 Sep 7, 2015
1.3 Apr 27, 2015
1.2.2 Apr 22, 2015