bhanditz / swagger-core

Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API

Swagger Core

NOTE: If you're looking for Swagger Core 1.5.X and OpenAPI 2.0, please refer to 1.5 branch.

Swagger Core is a Java implementation of the OpenAPI Specification. Current version supports JAX-RS2.

Get started with Swagger Core!

See the guide on getting started with Swagger Core to get started with adding Swagger to your API.

See the Wiki!

The github wiki contains documentation, samples, contributions, etc. Start 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.6 (current stable)	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.5.21 (current stable)	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

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
• Apache maven 3.0.4 or greater
• Jackson 2.4.5 or greater

To build from source (currently 2.0.7-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.