|
2 | 2 |
|
3 | 3 | [](https://travis-ci.org/wordnik/swagger-core) |
4 | 4 |
|
5 | | -## [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 including 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 |
14 | | -* [Swagger UI](https://github.com/wordnik/swagger-ui/issues) |
15 | | -* [Swagger codegen](https://github.com/wordnik/swagger-codegen/issues) |
16 | 21 |
|
17 | 22 | ## Get started with Swagger! |
18 | 23 | 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 |
|
|
0 commit comments