{"id":13755400,"url":"https://springfox.github.io/springfox/","last_synced_at":"2025-05-10T01:30:57.553Z","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":5931,"open_issues_count":309,"forks_count":1538,"subscribers_count":264,"default_branch":"master","last_synced_at":"2024-10-29T10:25:44.360Z","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":"2024-10-29T00:14:55.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,"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","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222092115,"owners_count":16929788,"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":["java","oai","openapi","spring","spring-boot","spring-data-rest","springfox","swagger"],"created_at":"2024-08-03T10:00:53.634Z","updated_at":"2024-11-16T09:30:39.612Z","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":["Docs generator"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/springfox.github.io%2Fspringfox%2F","html_url":"https://awesome.ecosyste.ms/projects/springfox.github.io%2Fspringfox%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/springfox.github.io%2Fspringfox%2F/lists"}