bhanditz / swagger-play-1.2

Swagger Play Framework Module

Disclaimer

This project is maintained and no support will be provided. It is available as-is for your reference. Keep in mind it produces an old version of the Swagger specification which is soon to reach an end-of-life state.

Overview

This is a project to add swagger to play-framework; an implementation of the Swagger spec.
You can find out more about both the spec and the framework at http://swagger.io.
For more information about Wordnik's APIs, please visit http://developer.wordnik.com.

(This is for Play 1.2.x. If you're working with Play 2.0 and above, please look at https://github.com/swagger-api/swagger-core)

Prerequisites

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

- Play Framework 1.2.x

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

To build

The swagger-play module depends on swagger-core_2.8.1-1.1. You can find this artifact in a public maven repo:

https://oss.sonatype.org/content/repositories/releases/com/wordnik/swagger-core_2.8.1/

Get the dependencies for the swagger-play module:

export SCALA_HOME=path/to/scala-2.8.1
play deps --sync
play build-module