Skip to content
This repository

Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Swagger Core library

Overview

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.

Version history

v1.01 Jan-31 2012

- Transitioned build to Maven

- Removed jaxrs dependencies from swagger-core

- Moved sample server implementations into /samples directory

- Added support for alternate API listing paths

- Made .{format} optional

- Added crazy scala versioning into artifact names (Scala 2.8.1 => ${artifact}_2.8.1)

- Added test and integration test through default maven integration-test lifecycle

v1.0 Aug-10 2011

- Initial release of swagger

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)

Prerequisites

You need the following installed and available in your $PATH:

- Java 1.6 or greater (http://java.oracle.com)

- Apache maven 3.0.3 or greater (http://maven.apache.org/)

- Scala 2.8.1 (http://www.scala-lang.org).

To build from source (currently 1.02-SNAPSHOT)

# first time building locally
mvn -N

Subsequent builds

mvn install

This will build the modules and sample apps.

Sample Apps

There are a number of sample apps in the

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:

# run scala-jaxrs sample app
cd samples/scala-jaxrs

mvn jetty:run

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

http://repo1.maven.org/maven2/com/wordnik/

Something went wrong with that request. Please try again.