springfox /springfox
Automated JSON API documentation for API's built with Spring
★ 5,915⑂ 1,505👁 255⑃ 546● 3,542▤ 12
-1
日增长
5,915
stars
1,505
forks
255
watchers
546
prs
3,542
issues
12
releases
README
Springfox

| Build Status | Coverage | Code Analysis |
|---|---|---|
|| ||
| Sonar Cloud |
|------------ |
||
||
||
||
||
||
About
For more information on this project visit the Springfox Website or
http://springfox.github.io/springfox/
Useful links
- Reference Documentation
- Examples repository
- Contribution Guidelines
- Core contributors
- Development and contribution guidelines
- Change log
- Development Environment
- Release Instructions
Getting Started
For new projects
For Maven
xml
io.springfox
springfox-boot-starter
3.0.0
For Gradle
gradle
implementation "io.springfox:springfox-boot-starter:"
Migrating from earlier snapshot
Spring Boot Applications
NOTE: Would love feedback to make this better
1. Remove explicit dependencies on springfox-swagger2
2. Remove any @EnableSwagger2... annotations
3. Add the springfox-boot-starter dependency
4. Springfox 3.x removes dependencies on guava and other 3rd party libraries (not zero dep yet! depends on spring plugin
and open api libraries for annotations and models) so if you used guava predicates/functions those will need to
transition to java 8 function interfaces.
Migrating from existing 2.x version
Spring Boot Applications
NOTE: Would love feedback to make this better
1. Remove explicit dependencies on springfox-swagger2
2. Remove the @EnableSwagger2 annotations
3. Add the springfox-boot-starter dependency
4. Springfox 3.x removes dependencies on guava and other 3rd party libraries (not zero dep yet! depends on spring plugin
and open api libraries for annotations and models) so if you used guava predicates/functions those will need to
transition to java 8 function interfaces
5. If you are using WebMvc but you don't use the @EnableWebMvc annotation yet, add this annotation.
Regular spring mvc
NOTE: Would love feedback to make this experience better
1. Remove explicit dependencies on springfox-swagger2
2. Add @EnableOpenApi for open API (and @EnableSwagger2WebMvc or @EnableSwagger2WebFlux for older versions)
3. Added the springfox-oas library
4. Springfox 3.x removes dependencies on guava and other 3rd party libraries (not zero dep yet! depends on spring plugin
and open api libraries for annotations and models) so if you used guava predicates/functions those will need to
transition to java 8 function interfaces
License
-------
Copyright 2015 Marty Pitt - @martypitt, Dilip Krishnan - @dilipkrish,
Adrian Kelly - @adrianbk,
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific laTop issues
#3462Spring 5.3/Spring Boot 2.4 support101 comments · 2020-07-29#2064java 9 library compatibility issue56 comments · 2017-10-09#807Ignore specific properties conditionally (Support @JsonView)54 comments · 2015-06-20#2304[Question] How can you modify page title or header title of the swagger-ui page38 comments · 2018-03-16#1738Duplicated enumerations in swagger definitions34 comments · 2017-03-24#2881Slow scanning time on SpringMVC application33 comments · 2019-01-25#2623Swagger UI unwrapping Spring Data `Pageable` with wrong field names30 comments · 2018-08-15#651Feature request: an option for YAML output30 comments · 2015-04-06
Latest release
3.0.0 3.0.0 2020-07-14Release Notes !image Picture Credit National Geographic First and foremost a big thank you to the community for keeping me motivated to work on this project. There have been some really amazing contributions in this release in terms of code, comments, bug reports and it is humbling to see people jumping in to solve problems on the issue forum. It sure motivated me to get over the "hump" and start working on in earnest. What better way to lose the COVID blues! __Thank you!__ 🥳 🍾 Also please welcome the newest maintainer to the springfox team @MaksimOrlov. A lot of the great work y