springfox-javadoc


License

License

Apache-2.0
GroupId

GroupId

io.springfox
ArtifactId

ArtifactId

springfox-javadoc
Last Version

Last Version

0.9.4
Release Date

Release Date

Type

Type

jar
Description

Description

springfox-javadoc
springfox-javadoc
Project URL

Project URL

https://github.com/springfox/springfox-javadoc
Source Code Management

Source Code Management

https://github.com/springfox/springfox-javadoc.git

Download springfox-javadoc

How to add to project

<!-- https://jarcasting.com/artifacts/io.springfox/springfox-javadoc/ -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-javadoc</artifactId>
    <version>0.9.4</version>
</dependency>
// https://jarcasting.com/artifacts/io.springfox/springfox-javadoc/
implementation 'io.springfox:springfox-javadoc:0.9.4'
// https://jarcasting.com/artifacts/io.springfox/springfox-javadoc/
implementation ("io.springfox:springfox-javadoc:0.9.4")
'io.springfox:springfox-javadoc:jar:0.9.4'
<dependency org="io.springfox" name="springfox-javadoc" rev="0.9.4">
  <artifact name="springfox-javadoc" type="jar" />
</dependency>
@Grapes(
@Grab(group='io.springfox', module='springfox-javadoc', version='0.9.4')
)
libraryDependencies += "io.springfox" % "springfox-javadoc" % "0.9.4"
[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

CircleCI Codacy Badge FOSSA Status

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

FOSSA Status

io.springfox

Versions

Version
0.9.4