Skip to content

Commit fd4b3b7

Browse files
committed
Merge pull request #948 from swagger-api/master
prepare for next development release
2 parents 279a695 + 033a620 commit fd4b3b7

File tree

159 files changed

+10789
-21
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

159 files changed

+10789
-21
lines changed

LICENSE

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Copyright 2015 Reverb Technologies, Inc.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
6+
7+
Unless required by applicable law or agreed to in writing, software
8+
distributed under the License is distributed on an "AS IS" BASIS,
9+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10+
See the License for the specific language governing permissions and
11+
limitations under the License.

README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# Swagger Core library
22

3-
[![Build Status](https://travis-ci.org/swagger-api/swagger-core.svg?branch=develop_2.0)](https://travis-ci.org/swagger-api/swagger-core)
3+
[![Build Status](https://travis-ci.org/swagger-api/swagger-core.svg?branch=master)](https://travis-ci.org/swagger-api/swagger-core)
44

55
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.
66

7-
Swagger-core is the Java implementation of Swagger. Current version supports *JAX-RS*. Future milestone releases will add support for *plain Servlets* and *Play Framework*.
7+
Swagger-core is the Java implementation of Swagger. Current version supports *JAX-RS*. Future milestone releases will add support for *plain Servlets* and *Play Framework*.
88

99
Check out [Swagger-Spec](https://github.com/swagger-api/swagger-spec) for additional information about the Swagger project, including additional libraries with support for SpringMVC, other languages and more.
1010

11+
![Swagger Screenshot](https://raw.github.com/swagger-api/swagger-core/master/swagger-shot.jpg)
12+
1113
## See the Wiki!
1214
The [github wiki](https://github.com/swagger-api/swagger-core/wiki) contains documentation, samples, etc. Start there.
1315

@@ -27,10 +29,13 @@ The Swagger Specification has undergone 3 revisions since initial creation in 20
2729

2830
Swagger core Version | Release Date | Swagger Spec compatibility | Notes | Status
2931
------------------------- | ------------ | -------------------------- | ----- | ----
30-
1.5.0-M2 | 2015-03-30 | 2.0 | [master](https://github.com/swagger-api/swagger-core) |
31-
1.3.12 | 2014-12-23 | 1.2 | [tag v1.3.12](https://github.com/swagger-api/swagger-core/tree/v1.3.12)
32-
1.2.4 | 2013-06-19 | 1.1 | [tag swagger-project_2.10.0-1.2.4](https://github.com/swagger-api/swagger-core/tree/swagger-project_2.10.0-1.2.4)
33-
1.0.0 | 2011-10-16 | 1.0 | [tag v1.0](https://github.com/swagger-api/swagger-core/tree/v1.0)
32+
1.5.0-M2 | 2015-03-30 | 2.0 | [master](https://github.com/swagger-api/swagger-core) | Supported
33+
1.3.12 | 2014-12-23 | 1.2 | [tag v1.3.12](https://github.com/swagger-api/swagger-core/tree/v1.3.12) | Supported
34+
1.2.4 | 2013-06-19 | 1.1 | [tag swagger-project_2.10.0-1.2.4](https://github.com/swagger-api/swagger-core/tree/swagger-project_2.10.0-1.2.4) | Deprecated
35+
1.0.0 | 2011-10-16 | 1.0 | [tag v1.0](https://github.com/swagger-api/swagger-core/tree/v1.0) | Deprecated
36+
37+
## Where is Scala support?
38+
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 is moving outside the swagger-core project as well.
3439

3540
## Overview
3641
This is a project to build the swagger-core library, which is required for the Reverb implementation of the Swagger spec.
@@ -42,11 +47,10 @@ If you're interested in the change history of swagger and the swagger-core frame
4247
### Prerequisites
4348
You need the following installed and available in your $PATH:
4449

45-
<li>- Java 6 (http://java.oracle.com)
50+
* Java 6 (http://java.oracle.com)
51+
* Apache maven 3.0.4 or greater (http://maven.apache.org/)
52+
* Jackson 2.4.2 or greater
4653

47-
<li>- Apache maven 3.0.4 or greater (http://maven.apache.org/)
48-
49-
<li>- Jackson 2.4.2 or greater
5054

5155
### To build from source (currently 1.5.0-M2)
5256
```
@@ -59,14 +63,18 @@ Subsequent builds:
5963
mvn install
6064
```
6165

62-
This will build the modules and sample apps.
66+
This will build the modules. To build sample apps, activate the `samples` profile:
67+
68+
```
69+
mvn install -Psamples
70+
```
6371

6472
Of course if you don't want to build locally you can grab artifacts from maven central:
6573

6674
`http://repo1.maven.org/maven2/com/wordnik/`
6775

6876
## Sample Apps
69-
There are a number of sample apps in the [samples](https://github.com/swagger-api/swagger-core/tree/develop_2.0/samples) folder.
77+
There are a number of sample apps in the [samples](https://github.com/swagger-api/swagger-core/blob/master/samples) folder.
7078

7179
```
7280
@@ -84,3 +92,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
8492
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
8593
See the License for the specific language governing permissions and
8694
limitations under the License.
95+

modules/swagger-core/src/main/resources/logback.xml renamed to modules/swagger-core/src/test/resources/logback-test.xml

File renamed without changes.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<configuration>
3+
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
4+
<layout class="ch.qos.logback.classic.PatternLayout">
5+
<Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>
6+
</layout>
7+
</appender>
8+
<logger name="com.wordnik" level="error"/>
9+
<root level="error">
10+
<appender-ref ref="STDOUT" />
11+
</root>
12+
</configuration>

0 commit comments

Comments
 (0)