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
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
For Gradle
implementation "io.springfox:springfox-boot-starter:<version>"
Migrating from earlier snapshot
Spring Boot Applications
NOTE: Would love feedback to make this better
- Remove explicit dependencies on
springfox-swagger2
- Remove any
@EnableSwagger2...
annotations - Add the
springfox-boot-starter
dependency - 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
- Remove explicit dependencies on
springfox-swagger2
- Remove the
@EnableSwagger2
annotations - Add the
springfox-boot-starter
dependency - 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
- 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
- Remove explicit dependencies on
springfox-swagger2
- Add
@EnableOpenApi
for open API (and@EnableSwagger2WebMvc
or@EnableSwagger2WebFlux
for older versions) - Added the
springfox-oas
library - 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 language governing permissions and limitations under the License.