springfox-javadoc

License	Apache-2.0
GroupId	io.springfox
ArtifactId	springfox-javadoc
Last Version	0.9.4
Release Date	May 3, 2018
Type	jar
Description	springfox-javadoc springfox-javadoc
Project URL	https://github.com/springfox/springfox-javadoc
Source Code Management	https://github.com/springfox/springfox-javadoc.git

Download springfox-javadoc

Filename	Size
springfox-javadoc-0.9.4.pom
springfox-javadoc-0.9.4.jar	13 KB
springfox-javadoc-0.9.4-sources.jar	9 KB
springfox-javadoc-0.9.4-javadoc.jar	39 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.springfox/springfox-javadoc/ -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-javadoc</artifactId>
    <version>0.9.4</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.springfox/springfox-javadoc/
implementation 'io.springfox:springfox-javadoc:0.9.4'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.springfox/springfox-javadoc/
implementation ("io.springfox:springfox-javadoc:0.9.4")

Apache Buildr

'io.springfox:springfox-javadoc:jar:0.9.4'

Apache Ivy

<dependency org="io.springfox" name="springfox-javadoc" rev="0.9.4">
  <artifact name="springfox-javadoc" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.springfox', module='springfox-javadoc', version='0.9.4')
)

Scala SBT

libraryDependencies += "io.springfox" % "springfox-javadoc" % "0.9.4"

Leiningen

[io.springfox/springfox-javadoc "0.9.4"]

Dependencies

compile (2)

Group / Artifact	Type	Version
io.springfox : springfox-swagger2	jar	2.9.0
org.springframework : spring-webmvc	jar	4.3.9.RELEASE

Project Modules

There are no modules declared in this project.

springfox-javadoc

Ability to use Javadoc for documentation for generating OpenAPI specifications

To use this, make sure that JavadocPluginConfiguration is found by your spring context and add the execution of the javadoc doclet to your build process.

Maven example:

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.10.4</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>javadoc</goal>
                        </goals>
                        <phase>process-classes</phase>
                        <configuration>
                            <doclet>springfox.javadoc.doclet.SwaggerPropertiesDoclet</doclet>
                            <docletArtifact>
                                <groupId>io.springfox</groupId>
                                <artifactId>springfox-javadoc</artifactId>
                                <version>${springfox-javadoc.version}</version>
                            </docletArtifact>
                            <additionalparam>
                                -classdir ${project.build.outputDirectory}
                            </additionalparam>
                            <sourcepath>${project.build.sourceDirectory}</sourcepath>
                            <subpackages>your.rest.service.package</subpackages>
                            <useStandardDocletOptions>false</useStandardDocletOptions>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

License

Versions

Version
0.9.4 May 3, 2018