The github wiki contains documentation, samples, etc. Start there
This is a project to build the swagger-core library, which is required for the Wordnik implementation of the Swagger spec. You can find out more about both the spec and the framework at http://swagger.wordnik.com. For more information about Wordnik's APIs, please visit http://developer.wordnik.com.
Pre-release versions will be suffixed with SNAPSHOT and RC appropriately. If you want the release version, please grab it by tag (i.e. v1.0 for the release)
You need the following installed and available in your $PATH:
# first time building locally
mvn -N
Subsequent builds:
mvn install
This will build the modules and sample apps.
Of course if you don't want to build locally you can grab artifacts from maven central:
http://repo1.maven.org/maven2/com/wordnik/
There are a number of sample apps in the samples folder:
java-jaxrs Java-based swagger server with JAX-RS
scala-jaxrs Scala-based swagger server with JAX-RS
java-alt-resource-listing Scala-based swagger server with JAX-RS with an alternate resource listing scheme
scala-alt-resource-listing Scala-based swagger server with JAX-RS with an alternate resource listing scheme
scala-jaxrs-apm Scala-based swagger server using wordnik-oss utils for Application Performance Monitoring (APM)
To run a sample app after initial compile:
# run scala-jaxrs sample app
cd samples/scala-jaxrs
mvn jetty:run
And the Play2 samples:
java-play2 Java-based Play2 sample app
scala-play2 Scala-based Play2 sample app
scala-play2-no-format Scala-based Play2 sample app without the .{format} in resource listing
To run the Play2 sample apps:
cd samples/java-play2
play run
Copyright 2013 Reverb Technologies, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.