Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/springfox/springfox

Automated JSON API documentation for API's built with Spring
https://github.com/springfox/springfox

java oai openapi spring spring-boot spring-data-rest springfox swagger

Last synced: 4 days ago
JSON representation

Automated JSON API documentation for API's built with Spring

Host: GitHub
URL: https://github.com/springfox/springfox
Owner: springfox
License: apache-2.0
Created: 2012-05-06T06:38:57.000Z (over 12 years ago)
Default Branch: master
Last Pushed: 2024-03-18T18:36:28.000Z (11 months ago)
Last Synced: 2025-01-26T00:14:40.172Z (7 days ago)
Topics: java, oai, openapi, spring, spring-boot, spring-data-rest, springfox, swagger
Language: Java
Homepage: http://springfox.io
Size: 178 MB
Stars: 5,930
Watchers: 263
Forks: 1,535
Open Issues: 311
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Springfox

[![Join the chat at https://gitter.im/springfox/springfox](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/springfox/springfox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![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)

[ ![Download](https://api.bintray.com/packages/springfox/maven-repo/springfox/images/download.svg) ](https://bintray.com/springfox/maven-repo/springfox/_latestVersion) 

[![Project Stats](https://www.openhub.net/p/springfox/widgets/project_thin_badge.gif)](https://www.openhub.net/p/springfox)

| Build Status  | Coverage   | Code Analysis |

|---|---|---|

|[![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&metric=alert_status)](https://sonarcloud.io/dashboard?id=springfox_springfox)|

| Sonar Cloud |

|------------ |

|[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox&metric=security_rating)](https://sonarcloud.io/dashboard?id=springfox_springfox)|

|[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=springfox_springfox)|

|[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=springfox_springfox)|

|[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=springfox_springfox)|

|[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox&metric=sqale_index)](https://sonarcloud.io/dashboard?id=springfox_springfox)|

|[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=springfox_springfox&metric=coverage)](https://sonarcloud.io/dashboard?id=springfox_springfox)|

### About

For more information on this project visit the [Springfox Website](http://springfox.io) or

 [http://springfox.github.io/springfox/](http://springfox.github.io/springfox/)

### Useful links

- [Reference Documentation](http://springfox.io)

- [Examples repository](https://github.com/springfox/springfox-demos)

- [Contribution Guidelines](https://github.com/springfox/springfox/wiki/Contribution-guidelines)

- [Core contributors](http://springfox.github.io/springfox/contributors.html)

- [Development and contribution guidelines](https://github.com/martypitt/swagger-springmvc/wiki/Development)

- [Change log](docs/release-notes.md)

- [Development Environment](http://springfox.github.io/springfox/docs/current/#development-environment)

- [Release Instructions](http://springfox.github.io/springfox/docs/current/#releasing)

### 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`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/config/annotation/EnableWebMvc.html) 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](https://github.com/martypitt), Dilip Krishnan - [@dilipkrish](https://github.com/dilipkrish),

Adrian Kelly -  [@adrianbk](https://github.com/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](http://www.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](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)