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
## [See the Wiki!](https://github.com/wordnik/swagger-core/wiki)
6
-
The [github wiki](https://github.com/wordnik/swagger-core/wiki) contains documentation, samples, etc. Start there
5
+
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, Swager removes the guesswork in calling the service.
7
6
8
-
## Where to get help!
9
-
Search the [swagger google groups](https://groups.google.com/forum/#!forum/swagger-swaggersocket) for previously
10
-
asked questions. Join #swagger on irc.freenode.net to talk to interesting human beings. And if you find a bug,
11
-
file it in github:
7
+
Swagger-core is the Java/Scala implementation of Swagger. It supports *JAX-RS*, *plain Servlets*, and *Play Framework*.
8
+
9
+
Check out [Swagger-Spec](https://github.com/wordnik/swagger-spec) for additional information about the Swagger project, including additional libraries with support for SpringMVC, other languages and more.
10
+
11
+
## See the Wiki!
12
+
The [github wiki](https://github.com/wordnik/swagger-core/wiki) contains documentation, samples, etc. Start there.
13
+
14
+
## Support
15
+
The following methods are available to obtain support for Swagger:
16
+
17
+
-[The Swagger Google Group](https://groups.google.com/forum/#!forum/swagger-swaggersocket) - 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.
18
+
- The [Issues tab](https://github.com/wordnik/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.
19
+
- IRC! you can find us on [freenode](irc://irc.freenode.net) in the channel #Swagger. You can talk with us directly there.
12
20
13
-
*[Swagger core + server integrations](https://github.com/wordnik/swagger-core/issues) issues
See the guide on [getting started with swagger](https://github.com/wordnik/swagger-core/wiki/Adding-Swagger-to-your-API) to get started with adding swagger to your API.
19
24
20
25
21
26
## Overview
22
27
This is a project to build the swagger-core library, which is required for the Wordnik
23
-
implementation of the Swagger spec. You can find out more about both the spec and the
24
-
framework at http://swagger.wordnik.com. For more information about Wordnik's APIs, please
28
+
implementation of the Swagger spec. For more information about Wordnik's APIs, please
25
29
visit http://developer.wordnik.com.
26
30
27
31
@@ -36,9 +40,7 @@ You need the following installed and available in your $PATH:
36
40
37
41
<li>- Apache maven 3.0.3 or greater (http://maven.apache.org/)
38
42
39
-
<li>- Scala 2.9.1-1 [available here](http://www.scala-lang.org). Note that 2.9.1 has a defect which causes problems with Jax-RS
40
-
41
-
### To build from source (currently 1.3.0)
43
+
### To build from source (currently 1.3.4)
42
44
```
43
45
# first time building locally
44
46
mvn -N
@@ -62,12 +64,6 @@ There are a number of sample apps in the `samples` folder:
62
64
63
65
[scala-jaxrs](https://github.com/wordnik/swagger-core/tree/master/samples/scala-jaxrs/README.md) Scala-based swagger server with JAX-RS
[scala-play2-no-format](https://github.com/wordnik/swagger-core/tree/master/samples/scala-play2-no-format) Scala-based Play2 sample app without the .{format} in resource listing
90
-
91
85
To run the Play2 sample apps:
92
86
93
87
```
@@ -99,7 +93,7 @@ play run
99
93
License
100
94
-------
101
95
102
-
Copyright 2013 Reverb Technologies, Inc.
96
+
Copyright 2014 Reverb Technologies, Inc.
103
97
104
98
Licensed under the Apache License, Version 2.0 (the "License");
105
99
you may not use this file except in compliance with the License.
JsonSerializer.asJson(models) should be ("""[{"id":"ModelWithIgnorePropertiesAnnotation","properties":{"name":{"type":"string"},"favoriteAnimal":{"type":"string"}}}]""")
0 commit comments