{"id":23722381,"url":"https://github.com/springfox/springfox-javadoc","last_synced_at":"2025-09-03T23:31:41.416Z","repository":{"id":48666347,"uuid":"117391072","full_name":"springfox/springfox-javadoc","owner":"springfox","description":"Ability to use Javadoc for documentation for generating OpenAPI specifications","archived":false,"fork":false,"pushed_at":"2021-07-15T06:08:24.000Z","size":191,"stargazers_count":17,"open_issues_count":18,"forks_count":15,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-05-09T09:05:19.989Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/springfox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-14T01:01:07.000Z","updated_at":"2023-12-14T19:44:31.000Z","dependencies_parsed_at":"2022-09-07T18:22:13.282Z","dependency_job_id":null,"html_url":"https://github.com/springfox/springfox-javadoc","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox-javadoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox-javadoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox-javadoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox-javadoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/springfox","download_url":"https://codeload.github.com/springfox/springfox-javadoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231926373,"owners_count":18447052,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-30T23:51:46.541Z","updated_at":"2024-12-30T23:51:46.993Z","avatar_url":"https://github.com/springfox.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# springfox-javadoc\n\n[![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\u0026utm_medium=referral\u0026utm_content=springfox/springfox-javadoc\u0026utm_campaign=badger)\n[![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)\n\nAbility to use Javadoc for documentation for generating OpenAPI specifications\n\nTo use this, make sure that `JavadocPluginConfiguration` is found by your spring context and add the execution of the javadoc doclet to your build process.\n\nMaven example:\n```xml\n            \u003cplugin\u003e\n                \u003cgroupId\u003eorg.apache.maven.plugins\u003c/groupId\u003e\n                \u003cartifactId\u003emaven-javadoc-plugin\u003c/artifactId\u003e\n                \u003cversion\u003e2.10.4\u003c/version\u003e\n                \u003cexecutions\u003e\n                    \u003cexecution\u003e\n                        \u003cgoals\u003e\n                            \u003cgoal\u003ejavadoc\u003c/goal\u003e\n                        \u003c/goals\u003e\n                        \u003cphase\u003eprocess-classes\u003c/phase\u003e\n                        \u003cconfiguration\u003e\n                            \u003cdoclet\u003espringfox.javadoc.doclet.SwaggerPropertiesDoclet\u003c/doclet\u003e\n                            \u003cdocletArtifact\u003e\n                                \u003cgroupId\u003eio.springfox\u003c/groupId\u003e\n                                \u003cartifactId\u003espringfox-javadoc\u003c/artifactId\u003e\n                                \u003cversion\u003e${springfox-javadoc.version}\u003c/version\u003e\n                            \u003c/docletArtifact\u003e\n                            \u003cadditionalparam\u003e\n                                -classdir ${project.build.outputDirectory}\n                            \u003c/additionalparam\u003e\n                            \u003csourcepath\u003e${project.build.sourceDirectory}\u003c/sourcepath\u003e\n                            \u003csubpackages\u003eyour.rest.service.package\u003c/subpackages\u003e\n                            \u003cuseStandardDocletOptions\u003efalse\u003c/useStandardDocletOptions\u003e\n                        \u003c/configuration\u003e\n                    \u003c/execution\u003e\n                \u003c/executions\u003e\n            \u003c/plugin\u003e\n```\n\n\n## License\n[![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)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringfox%2Fspringfox-javadoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspringfox%2Fspringfox-javadoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringfox%2Fspringfox-javadoc/lists"}