You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
10
6
11
-
Swagger-core is the Java implementation of Swagger. Current version supports *JAX-RS* and plain servlets. Integration with the Play! framework has been moved to [Swagger-Play](https://github.com/swagger-api/swagger-play).
12
-
13
-
Check out [Swagger-Spec](https://github.com/OAI/OpenAPI-Specification) for additional information about the Swagger project, including additional libraries with support for SpringMVC, other languages and more.
Swagger-core is the Java implementation of Swagger. Current version supports *JAX-RS2*.
16
8
17
-
## See the Wiki!
18
-
The [github wiki](https://github.com/swagger-api/swagger-core/wiki) contains documentation, samples, contributions, etc. Start there.
9
+
Check out the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) for additional information about the Swagger project.
19
10
20
11
## Support
21
12
The following methods are available to obtain support for Swagger:
@@ -24,23 +15,17 @@ The following methods are available to obtain support for Swagger:
24
15
- The [Issues tab](https://github.com/swagger-api/swagger-core/issues?state=open) - 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.
25
16
- IRC! you can find us on [freenode](http://webchat.freenode.net/?channels=swagger) in the channel #Swagger. You can talk with us directly there.
26
17
27
-
28
-
## Get started with Swagger!
29
-
See the guide on [getting started with swagger](https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-JAX-RS-Project-Setup-1.5.X) to get started with adding swagger to your API.
30
-
31
18
## Compatibility
32
-
The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The swagger-core project has the following compatibilities with the OpenAPI Specification:
19
+
The OpenAPI Specification has undergone several revisions since initial creation in 2010. The swagger-core project has the following compatibilities with the OpenAPI Specification:
33
20
34
21
Swagger core Version | Release Date | OpenAPI Spec compatibility | Notes | Status
To allow independent development, scala support has been moved into a separate project. See the [swagger-scala-module](https://github.com/swagger-api/swagger-scala-module) for details. Play! framework support has moved to [swagger-play](https://github.com/swagger-api/swagger-play).
44
29
45
30
## Overview
46
31
This is a project to build the swagger-core library, which is required for the Swagger implementation of the OpenAPI Spec.
@@ -51,12 +36,12 @@ If you're interested in the change history of swagger and the swagger-core frame
51
36
### Prerequisites
52
37
You need the following installed and available in your $PATH:
53
38
54
-
* Java 7 (http://java.oracle.com)
39
+
* Java 8 (http://java.oracle.com)
55
40
* Apache maven 3.0.4 or greater (http://maven.apache.org/)
56
41
* Jackson 2.4.5 or greater
57
42
58
43
59
-
### To build from source (currently 1.5.11)
44
+
### To build from source (currently 2.0.0-SNAPSHOT)
60
45
```
61
46
# first time building locally
62
47
mvn -N
@@ -73,8 +58,8 @@ Of course if you don't want to build locally you can grab artifacts from maven c
73
58
74
59
`http://repo1.maven.org/maven2/io/swagger/`
75
60
76
-
## Sample Apps - *UPDATED*
77
-
The samples have moved to [a new repository](https://github.com/swagger-api/swagger-samples) and contain various integrations and configurations.
61
+
## Sample Apps
62
+
The samples have moved to [a new repository](https://github.com/swagger-api/swagger-samples/tree/2.0) and contain various integrations and configurations.
78
63
79
64
80
65
## License
@@ -92,3 +77,28 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
92
77
See the License for the specific language governing permissions and
93
78
limitations under the License.
94
79
```
80
+
81
+
## v2.0.0-rc0 Notable Features:
82
+
83
+
- First official release candidate of OpenApi 3.0 support. swagger-core now produces OpenAPI 3.0 specs only. swagger-core 2.0 version is not backward compatible with previous 1.x versions.
84
+
- Available on Maven central, and the sources are in the 2.0 branch. PRs should be submitted against the 2.0 branch.
85
+
- Swagger JAX-RS 2 support
86
+
- Java 8
87
+
- Consistent integration mechanism
88
+
89
+
## v2.0.0-rc0 Limitations
90
+
91
+
- Resolve resource operations also when not annotated with `@Operation`_(swagger-jaxrs2)_
92
+
- Implement `subtypes` field in `Schema` annotation, with related resolver processing _(swagger-annotations / core)_
93
+
- Overriding full support _(swagger-core)_
94
+
* Schema annotation `type` + `format` full support _(swagger-core)_
95
+
* Schema annotation `implementation` field full support _(swagger-core)_
96
+
- Filter / Reader listener support _(swagger-jaxrs2)_
97
+
- Reader sub-resources support _(swagger-jaxrs2)_
98
+
- Reader extensions full support _(swagger-jaxrs2)_
0 commit comments