{"id":13511848,"url":"https://github.com/springfox/springfox","last_synced_at":"2025-12-17T02:54:44.441Z","repository":{"id":38184928,"uuid":"4238977","full_name":"springfox/springfox","owner":"springfox","description":"Automated JSON API documentation for API's built with Spring","archived":false,"fork":false,"pushed_at":"2024-03-18T18:36:28.000Z","size":186279,"stargazers_count":5942,"open_issues_count":266,"forks_count":1523,"subscribers_count":259,"default_branch":"master","last_synced_at":"2025-11-27T13:36:35.154Z","etag":null,"topics":["java","oai","openapi","spring","spring-boot","spring-data-rest","springfox","swagger"],"latest_commit_sha":null,"homepage":"http://springfox.io","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":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-05-06T06:38:57.000Z","updated_at":"2025-11-26T09:32:38.000Z","dependencies_parsed_at":"2023-01-31T08:30:58.194Z","dependency_job_id":"e4a68a40-7bfd-4e41-ad5c-f4fd4abeea7c","html_url":"https://github.com/springfox/springfox","commit_stats":{"total_commits":3207,"total_committers":214,"mean_commits":"14.985981308411215","dds":0.8107265357031493,"last_synced_commit":"ab5868471cdbaf54dac01af12933fe0437cf2b01"},"previous_names":["martypitt/swagger-springmvc"],"tags_count":88,"template":false,"template_full_name":null,"purl":"pkg:github/springfox/springfox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/springfox","download_url":"https://codeload.github.com/springfox/springfox/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox/sbom","scorecard":{"id":622167,"data":{"date":"2025-08-11","repo":{"name":"github.com/springfox/springfox","commit":"ab5868471cdbaf54dac01af12933fe0437cf2b01"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.1,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":2,"reason":"Found 4/16 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 18 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"58 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T05:26:53.627Z","repository_id":38184928,"created_at":"2025-08-21T05:26:53.627Z","updated_at":"2025-08-21T05:26:53.627Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27775740,"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","status":"online","status_checked_at":"2025-12-17T02:00:08.291Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["java","oai","openapi","spring","spring-boot","spring-data-rest","springfox","swagger"],"created_at":"2024-08-01T03:01:13.750Z","updated_at":"2025-12-17T02:54:44.425Z","avatar_url":"https://github.com/springfox.png","language":"Java","readme":"# Springfox\n\n[![Join the chat at https://gitter.im/springfox/springfox](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/springfox/springfox?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox?ref=badge_shield)\n[ ![Download](https://api.bintray.com/packages/springfox/maven-repo/springfox/images/download.svg) ](https://bintray.com/springfox/maven-repo/springfox/_latestVersion) \n[![Project Stats](https://www.openhub.net/p/springfox/widgets/project_thin_badge.gif)](https://www.openhub.net/p/springfox)\n\n| Build Status  | Coverage   | Code Analysis |\n|---|---|---|\n|[![Circle CI](https://circleci.com/gh/springfox/springfox/tree/master.svg?style=svg)](https://circleci.com/gh/springfox/springfox/tree/master)|[![codecov](https://codecov.io/gh/springfox/springfox/branch/master/graph/badge.svg)](https://codecov.io/gh/springfox/springfox) |[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=springfox_springfox)|\n\n| Sonar Cloud |\n|------------ |\n|[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox\u0026metric=security_rating)](https://sonarcloud.io/dashboard?id=springfox_springfox)|\n|[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox\u0026metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=springfox_springfox)|\n|[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=springfox_springfox)|\n|[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox\u0026metric=reliability_rating)](https://sonarcloud.io/dashboard?id=springfox_springfox)|\n|[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox\u0026metric=sqale_index)](https://sonarcloud.io/dashboard?id=springfox_springfox)|\n|[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=springfox_springfox)|\n\n### About\nFor more information on this project visit the [Springfox Website](http://springfox.io) or\n [http://springfox.github.io/springfox/](http://springfox.github.io/springfox/)\n\n### Useful links\n- [Reference Documentation](http://springfox.io)\n- [Examples repository](https://github.com/springfox/springfox-demos)\n- [Contribution Guidelines](https://github.com/springfox/springfox/wiki/Contribution-guidelines)\n- [Core contributors](http://springfox.github.io/springfox/contributors.html)\n- [Development and contribution guidelines](https://github.com/martypitt/swagger-springmvc/wiki/Development)\n- [Change log](docs/release-notes.md)\n- [Development Environment](http://springfox.github.io/springfox/docs/current/#development-environment)\n- [Release Instructions](http://springfox.github.io/springfox/docs/current/#releasing)\n\n### Getting Started\n\n#### For new projects\nFor Maven\n```xml \n\u003cdependency\u003e\n    \u003cgroupId\u003eio.springfox\u003c/groupId\u003e\n    \u003cartifactId\u003espringfox-boot-starter\u003c/artifactId\u003e\n    \u003cversion\u003e3.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n\n```\n\nFor Gradle\n```gradle \n  implementation \"io.springfox:springfox-boot-starter:\u003cversion\u003e\"\n```\n#### Migrating from earlier snapshot \n#### Spring Boot Applications\nNOTE: Would love feedback to make this better\n1. Remove explicit dependencies on `springfox-swagger2`\n2. Remove any `@EnableSwagger2...` annotations\n3. Add the `springfox-boot-starter` dependency\n4. Springfox 3.x removes dependencies on guava and other 3rd party libraries (not zero dep yet! depends on spring plugin\nand open api libraries for annotations and models) so if you used guava predicates/functions those will need to \ntransition to java 8 function interfaces.\n\n#### Migrating from existing 2.x version\n#### Spring Boot Applications\nNOTE: Would love feedback to make this better\n1. Remove explicit dependencies on `springfox-swagger2`\n2. Remove the `@EnableSwagger2` annotations\n3. Add the `springfox-boot-starter` dependency\n4. Springfox 3.x removes dependencies on guava and other 3rd party libraries (not zero dep yet! depends on spring plugin\nand open api libraries for annotations and models) so if you used guava predicates/functions those will need to \ntransition to java 8 function interfaces \n5. If you are using WebMvc but you don't use the [`@EnableWebMvc`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/config/annotation/EnableWebMvc.html) annotation yet, add this annotation.\n\n#### Regular spring mvc  \nNOTE: Would love feedback to make this experience better\n1. Remove explicit dependencies on `springfox-swagger2`\n2. Add `@EnableOpenApi` for open API (and `@EnableSwagger2WebMvc` or `@EnableSwagger2WebFlux` for older versions)  \n3. Added the `springfox-oas` library \n4. Springfox 3.x removes dependencies on guava and other 3rd party libraries (not zero dep yet! depends on spring plugin\nand open api libraries for annotations and models) so if you used guava predicates/functions those will need to \ntransition to java 8 function interfaces \n\n\nLicense\n-------\n\nCopyright 2015 Marty Pitt - [@martypitt](https://github.com/martypitt), Dilip Krishnan - [@dilipkrish](https://github.com/dilipkrish),\nAdrian Kelly -  [@adrianbk](https://github.com/adrianbk),\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n\n## License\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox?ref=badge_large)\n","funding_links":[],"categories":["Java","HarmonyOS"],"sub_categories":["Windows Manager"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringfox%2Fspringfox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspringfox%2Fspringfox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringfox%2Fspringfox/lists"}