NOTE: If you're looking for swagger 1.5.X and OpenApi 2.0, please refer to 1.5 branch
Swagger Core library
The goal of Swagger™ is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via Swagger, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, Swagger removes the guesswork in calling the service.
Swagger-core is the Java implementation of Swagger. Current version supports JAX-RS2.
Check out the OpenAPI Specification for additional information about the Swagger project.
Get started with Swagger!
See the guide on getting started with swagger to get started with adding swagger to your API.
See the Wiki!
The github wiki contains documentation, samples, contributions, etc. Start there.
Support
The following methods are available to obtain support for Swagger:
- The Swagger Google Group - This would normally be your first stop to get support for Swagger. Here you can find previously asked question, and ask new ones. When asking a question, please provide as much information as you can regarding the environment you use (development language, library, versions.
- The Issues tab - Please open feature requests and bugs here. If you're not sure you encountered a bug, or if it's a general usage question, please use the Google Group mentioned above.
- IRC! you can find us on freenode in the channel #Swagger. You can talk with us directly there.
Compatibility
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.0.2 (current stable) | 2018-05-24 | 3.0 | tag v2.0.2 | Supported |
| 2.0.1 | 2018-04-16 | 3.0 | tag v2.0.1 | Supported |
| 1.5.19 (current stable) | 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 | Deprecated |
| 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 |
Overview
This is a project to build the swagger-core library, which is required for the Swagger implementation of the OpenAPI Spec.
Change History
If you're interested in the change history of swagger and the swagger-core framework, see here.
Prerequisites
You need the following installed and available in your $PATH:
- Java 8 (http://java.oracle.com)
- Apache maven 3.0.4 or greater (http://maven.apache.org/)
- Jackson 2.4.5 or greater
To build from source (currently 2.0.3-SNAPSHOT)
# 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:
http://repo1.maven.org/maven2/io/swagger/
Sample Apps
The samples have moved to a new repository and contain various integrations and configurations.
License
Copyright 2018 SmartBear Software
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.