jamestyack/swagger-finatra

Finatra Swagger Support

swagger-finatra

Add Swagger support for Finatra (1.6 and 2.1.1) web framework.

Getting started

Gradle

Add repository

repositories {
  maven { url "https://oss.sonatype.org/content/repositories/releases/" }
}

Add Dependency

Scala 2.10, Finatra 2.1.1

compile "com.github.xiaodongw:swagger-finatra2_2.10:0.5.0"

Scala 2.11, Finatra 2.1.1

compile "com.github.xiaodongw:swagger-finatra2_2.11:0.5.0"

SBT

resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/releases/"

Add Dependency

Finatra 2.1.1

libraryDependencies += "com.github.xiaodongw" %% "swagger-finatra2" % "0.5.0"

Add document information for you controller

object SampleSwagger extends Swagger

class SampleController extends Controller with SwaggerSupport {
  implicit protected val swagger = SampleSwagger

  get("/students/:id",
    swagger { o =>
      o.summary("Read the detail information about the student")
        .tag("Student")
        .routeParam[String]("id", "the student id")
        .responseWith[Student](200, "the student details")
        .responseWith(404, "the student is not found")
    }) { request =>
    ...
  }

Add document controller

Finatra 2.1.1

object SampleApp extends HttpServer {
  val info = new Info()
    .description("The Student / Course management API, this is a sample for swagger document generation")
    .version("1.0.1")
    .title("Student / Course Management API")
  SampleSwagger.info(info)

  override def configureHttp(router: HttpRouter) {
    router
      .add(new SwaggerController(swagger = SampleSwagger))
      ...
  }
}

Swagger API document: http://localhost:8888/api-docs

Swagger UI: http://localhost:8888/api-docs/ui

Finatra 1.6

Previous version of Finatra (1.6) is also supported, Check here for the guide.