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.
6
6
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*.
8
8
9
9
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.
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.
34
39
35
40
## Overview
36
41
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
42
47
### Prerequisites
43
48
You need the following installed and available in your $PATH:
44
49
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
46
53
47
-
<li>- Apache maven 3.0.4 or greater (http://maven.apache.org/)
48
-
49
-
<li>- Jackson 2.4.2 or greater
50
54
51
55
### To build from source (currently 1.5.0-M2)
52
56
```
@@ -59,14 +63,18 @@ Subsequent builds:
59
63
mvn install
60
64
```
61
65
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
+
```
63
71
64
72
Of course if you don't want to build locally you can grab artifacts from maven central:
65
73
66
74
`http://repo1.maven.org/maven2/com/wordnik/`
67
75
68
76
## 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.
70
78
71
79
```
72
80
@@ -84,3 +92,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
84
92
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
85
93
See the License for the specific language governing permissions and
0 commit comments