Skip to content

Ability to use Javadoc for documentation for generating OpenAPI specifications

License

Notifications You must be signed in to change notification settings

springfox/springfox-javadoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8d085e9 · Nov 9, 2018

History

67 Commits
Feb 10, 2018
Aug 12, 2018
Feb 10, 2018
Aug 12, 2018
May 3, 2018
Feb 10, 2018
Mar 2, 2018
May 3, 2018
Jan 14, 2018
Nov 8, 2018
Aug 12, 2018
Aug 12, 2018
May 3, 2018
May 3, 2018
Feb 10, 2018
Feb 10, 2018
May 3, 2018
May 3, 2018
May 3, 2018

Repository files navigation

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