NOTE: If you're looking for Swagger Core 1.5.X and OpenAPI 2.0, please refer to 1.5 branch.
NOTE: Since version 2.1.7, Swagger Core also supports the Jakarta namespace. There are a parallel set of artifacts with the -jakarta suffix, providing the same functionality as the unsuffixed (i.e.: javax) artifacts.
Please see the Wiki for more details.
Swagger Core is a Java implementation of the OpenAPI Specification. Current version supports JAX-RS2 (javax and jakarta namespaces).
See the guide on getting started with Swagger Core to get started with adding Swagger to your API.
The github wiki contains documentation, samples, contributions, etc. Start there.
The OpenAPI Specification has undergone several revisions since initial creation in 2010. The Swagger Core project has the following compatibilities with the OpenAPI Specification:
| Swagger core Version | Release Date | OpenAPI Spec compatibility | Notes | Status |
|---|---|---|---|---|
| 2.1.11 (current stable) | 2021-09-29 | 3.0 | tag v2.1.11 | Supported |
| 2.1.10 | 2021-06-28 | 3.0 | tag v2.1.10 | Supported |
| 2.1.9 | 2021-04-20 | 3.0 | tag v2.1.9 | Supported |
| 2.1.8 | 2021-04-18 | 3.0 | tag v2.1.8 | Supported |
| 2.1.7 | 2021-02-18 | 3.0 | tag v2.1.7 | Supported |
| 2.1.6 | 2020-12-04 | 3.0 | tag v2.1.6 | Supported |
| 2.1.5 | 2020-10-01 | 3.0 | tag v2.1.5 | Supported |
| 2.1.4 | 2020-07-24 | 3.0 | tag v2.1.4 | Supported |
| 2.1.3 | 2020-06-27 | 3.0 | tag v2.1.3 | Supported |
| 2.1.2 | 2020-04-01 | 3.0 | tag v2.1.2 | Supported |
| 2.1.1 | 2020-01-02 | 3.0 | tag v2.1.1 | Supported |
| 2.1.0 | 2019-11-16 | 3.0 | tag v2.1.0 | Supported |
| 2.0.10 | 2019-10-11 | 3.0 | tag v2.0.10 | Supported |
| 2.0.9 | 2019-08-22 | 3.0 | tag v2.0.9 | Supported |
| 2.0.8 | 2019-04-24 | 3.0 | tag v2.0.8 | Supported |
| 2.0.7 | 2019-02-18 | 3.0 | tag v2.0.7 | Supported |
| 2.0.6 | 2018-11-27 | 3.0 | tag v2.0.6 | Supported |
| 2.0.5 | 2018-09-19 | 3.0 | tag v2.0.5 | Supported |
| 2.0.4 | 2018-09-05 | 3.0 | tag v2.0.4 | Supported |
| 2.0.3 | 2018-08-09 | 3.0 | tag v2.0.3 | Supported |
| 1.6.3 (current stable) | 2021-09-29 | 2.0 | tag v1.6.3 | Supported |
| 1.6.2 | 2020-07-01 | 2.0 | tag v1.6.2 | Supported |
| 1.6.1 | 2020-04-01 | 2.0 | tag v1.6.1 | Supported |
| 1.6.0 | 2019-11-16 | 2.0 | tag v1.6.0 | Supported |
| 1.5.24 | 2019-10-11 | 2.0 | tag v1.5.24 | Supported |
| 1.5.23 | 2019-08-22 | 2.0 | tag v1.5.23 | Supported |
| 1.5.22 | 2019-02-18 | 2.0 | tag v1.5.22 | Supported |
| 1.5.21 | 2018-08-09 | 2.0 | tag v1.5.21 | Supported |
| 1.5.20 | 2018-05-23 | 2.0 | tag v1.5.20 | Supported |
| 2.0.2 | 2018-05-23 | 3.0 | tag v2.0.2 | Supported |
| 2.0.1 | 2018-04-16 | 3.0 | tag v2.0.1 | Supported |
| 1.5.19 | 2018-04-16 | 2.0 | tag v1.5.19 | Supported |
| 2.0.0 | 2018-03-20 | 3.0 | tag v2.0.0 | Supported |
| 2.0.0-rc4 | 2018-01-22 | 3.0 | tag v2.0.0-rc4 | Supported |
| 2.0.0-rc3 | 2017-11-21 | 3.0 | tag v2.0.0-rc3 | Supported |
| 2.0.0-rc2 | 2017-09-29 | 3.0 | tag v2.0.0-rc2 | Supported |
| 2.0.0-rc1 | 2017-08-17 | 3.0 | tag v2.0.0-rc1 | Supported |
| 1.5.18 | 2018-01-22 | 2.0 | tag v1.5.18 | Supported |
| 1.5.17 | 2017-11-21 | 2.0 | tag v1.5.17 | Supported |
| 1.5.16 | 2017-07-15 | 2.0 | tag v1.5.16 | Supported |
| 1.3.12 | 2014-12-23 | 1.2 | tag v1.3.12 | Supported |
| 1.2.4 | 2013-06-19 | 1.1 | tag swagger-project_2.10.0-1.2.4 | Deprecated |
| 1.0.0 | 2011-10-16 | 1.0 | tag v1.0 | Deprecated |
If you're interested in the change history of swagger and the Swagger Core framework, see here.
You need the following installed and available in your $PATH:
- Java 8
- Apache maven 3.0.4 or greater
- Jackson 2.4.5 or greater
# first time building locally
mvn -N
Subsequent builds:
mvn install
This will build the modules.
Of course if you don't want to build locally you can grab artifacts from maven central:
https://repo1.maven.org/maven2/io/swagger/core/
The samples have moved to a new repository and contain various integrations and configurations.
Please disclose any security-related issues or vulnerabilities by emailing [email protected], instead of using the public issue tracker.