swagger-finatra

Add Swagger support for Finatra to generate REST API docuemnt

License	The Apache License, Version 2.0
Categories	Swagger Program Interface REST Frameworks
GroupId	com.github.xiaodongw
ArtifactId	swagger-finatra_2.11
Last Version	0.7.2
Release Date	Feb 10, 2017
Type	jar
Description	swagger-finatra Add Swagger support for Finatra to generate REST API docuemnt
Project URL	https://github.com/xiaodongw/swagger-finatra/
Source Code Management	https://github.com/xiaodongw/swagger-finatra.git

Download swagger-finatra_2.11

Filename	Size
swagger-finatra_2.11-0.7.2.pom
swagger-finatra_2.11-0.7.2.jar	43 KB
swagger-finatra_2.11-0.7.2-sources.jar	6 KB
swagger-finatra_2.11-0.7.2-javadoc.jar	261 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.xiaodongw/swagger-finatra_2.11/ -->
<dependency>
    <groupId>com.github.xiaodongw</groupId>
    <artifactId>swagger-finatra_2.11</artifactId>
    <version>0.7.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.xiaodongw/swagger-finatra_2.11/
implementation 'com.github.xiaodongw:swagger-finatra_2.11:0.7.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.xiaodongw/swagger-finatra_2.11/
implementation ("com.github.xiaodongw:swagger-finatra_2.11:0.7.2")

Apache Buildr

'com.github.xiaodongw:swagger-finatra_2.11:jar:0.7.2'

Apache Ivy

<dependency org="com.github.xiaodongw" name="swagger-finatra_2.11" rev="0.7.2">
  <artifact name="swagger-finatra_2.11" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.xiaodongw', module='swagger-finatra_2.11', version='0.7.2')
)

Scala SBT

libraryDependencies += "com.github.xiaodongw" % "swagger-finatra_2.11" % "0.7.2"

Leiningen

[com.github.xiaodongw/swagger-finatra_2.11 "0.7.2"]

Dependencies

compile (6)

Group / Artifact	Type	Version
org.scala-lang : scala-library	jar	2.11.8
io.swagger : swagger-core	jar	1.5.12
io.swagger : swagger-scala-module_2.11	jar	1.0.2
org.webjars : swagger-ui	jar	2.2.8
net.bytebuddy : byte-buddy	jar	1.6.1
com.twitter : finatra-http_2.11	jar	2.7.0

test (2)

Group / Artifact	Type	Version
org.scalatest : scalatest_2.11	jar	3.0.0
joda-time : joda-time	jar	2.9.4

Project Modules

There are no modules declared in this project.

swagger-finatra

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

It requires Java 8 from version 0.6.0.

Getting started

Gradle

Add repository

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

Add Dependency

Scala 2.10, Finatra 2.2.0

compile "com.github.xiaodongw:swagger-finatra_2.10:0.7.2"

Scala 2.11, Finatra 2.2.0

compile "com.github.xiaodongw:swagger-finatra_2.11:0.7.2"

SBT

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

Add Dependency

Finatra 2.2.0

libraryDependencies += "com.github.xiaodongw" %% "swagger-finatra" % "0.7.2"

Add document information for you controller

object SampleSwagger extends Swagger

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

  getWithDoc("/students/:id") { 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.2.0

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[WebjarsController]
      .add(new SwaggerController(swagger = SampleSwagger))
      ...
  }
}

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

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.

Versions

Version
0.7.2 Feb 10, 2017
0.7.1 Jan 9, 2017
0.7.0 Jan 9, 2017
0.6.0 Jul 15, 2016