springfox

by springfox

springfox / springfox

Automated JSON API documentation for API's built with Spring

4.8K Stars 1.4K Forks Last release: 3 months ago (3.0.0) Apache License 2.0 3.8K Commits 88 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Springfox

Join the chat at https://gitter.im/springfox/springfox FOSSA Status Download Project Stats

| Build Status | Coverage | Code Analysis | |---|---|---| |Circle CI|codecov |Quality Gate Status|

| Sonar Cloud | |------------ | |Security Rating| |Vulnerabilities| |Maintainability Rating| |Reliability Rating| |Technical Debt| |Coverage|

About

For more information on this project visit the Springfox Website or http://springfox.github.io/springfox/

Useful links

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 language governing permissions and limitations under the License.

License

FOSSA Status

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.