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

Ability to use Javadoc for documentation for generating OpenAPI specifications
https://github.com/springfox/springfox-javadoc

Last synced: 4 months ago
JSON representation

Ability to use Javadoc for documentation for generating OpenAPI specifications

• Host: GitHub
• URL: https://github.com/springfox/springfox-javadoc
• Owner: springfox
• License: apache-2.0
• Created: 2018-01-14T01:01:07.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-07-15T06:08:24.000Z (over 4 years ago)
• Last Synced: 2024-05-09T09:05:19.989Z (over 1 year ago)
• Language: Java
• Size: 187 KB
• Stars: 17
• Watchers: 9
• Forks: 15
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# springfox-javadoc

[![CircleCI](https://circleci.com/gh/springfox/springfox-javadoc.svg?style=svg)](https://circleci.com/gh/springfox/springfox-javadoc) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/32f99b3650794b5eb1f7c155a57d5100)](https://app.codacy.com/app/dilip-krishnan-github/springfox-javadoc?utm_source=github.com&utm_medium=referral&utm_content=springfox/springfox-javadoc&utm_campaign=badger)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox-javadoc.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox-javadoc?ref=badge_shield)

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:

```xml

            

                org.apache.maven.plugins

                maven-javadoc-plugin

                2.10.4

                

                    

                        

                            javadoc

                        

                        process-classes

                        

                            springfox.javadoc.doclet.SwaggerPropertiesDoclet

                            

                                io.springfox

                                springfox-javadoc

                                ${springfox-javadoc.version}

                            

                            

                                -classdir ${project.build.outputDirectory}

                            

                            ${project.build.sourceDirectory}

                            your.rest.service.package

                            false

                        

                    

                

            

```

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox-javadoc.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox-javadoc?ref=badge_large)