Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.twitter.finatra.http.SwaggerRouteDSL.scala Maven / Gradle / Ivy
package com.twitter.finatra.http
import com.jakehschwartz.finatra.swagger.FinatraSwagger
import com.twitter.finagle.http.{Request, Response, RouteIndex, Status}
import io.swagger.models.{Operation, Swagger}
/**
* To work around the accessibility of RouteDSL, this class is in "com.twitter.finatra.http" package
*/
object SwaggerRouteDSL {
implicit def convert(dsl: RouteDSL)(implicit swagger: Swagger): SwaggerRouteDSL = new SwaggerRouteDSLWrapper(dsl)(swagger)
}
trait SwaggerRouteDSL extends RouteDSL {
implicit protected val swagger: Swagger
val noopCallback: Request => Response = _ => response.SimpleResponse(Status.Ok, "")
def postWithDoc[RequestType: Manifest, ResponseType: Manifest](route: String,
name: String = "",
admin: Boolean = false,
routeIndex: Option[RouteIndex] = None,
registerOptionsRequest: Boolean = false)
(doc: Operation => Operation)
(callback: RequestType => ResponseType): Unit = {
registerOperation(route, "post")(doc)
post(route, name, admin, routeIndex)(callback)
if (registerOptionsRequest) {
options(route, name, admin, routeIndex)(noopCallback)
}
}
def getWithDoc[RequestType: Manifest, ResponseType: Manifest](route: String,
name: String = "",
admin: Boolean = false,
routeIndex: Option[RouteIndex] = None,
registerOptionsRequest: Boolean = false)
(doc: Operation => Operation)
(callback: RequestType => ResponseType): Unit = {
registerOperation(route, "get")(doc)
get(route, name, admin, routeIndex)(callback)
if (registerOptionsRequest) {
options(route, name, admin, routeIndex)(noopCallback)
}
}
def putWithDoc[RequestType: Manifest, ResponseType: Manifest](route: String,
name: String = "",
admin: Boolean = false,
routeIndex: Option[RouteIndex] = None,
registerOptionsRequest: Boolean = false)
(doc: Operation => Operation)
(callback: RequestType => ResponseType): Unit = {
registerOperation(route, "put")(doc)
put(route, name, admin, routeIndex)(callback)
if (registerOptionsRequest) {
options(route, name, admin, routeIndex)(noopCallback)
}
}
def patchWithDoc[RequestType: Manifest, ResponseType: Manifest](route: String,
name: String = "",
admin: Boolean = false,
routeIndex: Option[RouteIndex] = None,
registerOptionsRequest: Boolean = false)
(doc: Operation => Operation)
(callback: RequestType => ResponseType): Unit = {
registerOperation(route, "patch")(doc)
patch(route, name, admin, routeIndex)(callback)
if (registerOptionsRequest) {
options(route, name, admin, routeIndex)(noopCallback)
}
}
def headWithDoc[RequestType: Manifest, ResponseType: Manifest](route: String,
name: String = "",
admin: Boolean = false,
routeIndex: Option[RouteIndex] = None,
registerOptionsRequest: Boolean = false)
(doc: Operation => Operation)
(callback: RequestType => ResponseType): Unit = {
registerOperation(route, "head")(doc)
head(route, name, admin, routeIndex)(callback)
if (registerOptionsRequest) {
options(route, name, admin, routeIndex)(noopCallback)
}
}
def deleteWithDoc[RequestType: Manifest, ResponseType: Manifest](route: String,
name: String = "",
admin: Boolean = false,
routeIndex: Option[RouteIndex] = None,
registerOptionsRequest: Boolean = false)
(doc: Operation => Operation)
(callback: RequestType => ResponseType): Unit = {
registerOperation(route, "delete")(doc)
delete(route, name, admin, routeIndex)(callback)
if (registerOptionsRequest) {
options(route, name, admin, routeIndex)(noopCallback)
}
}
def optionsWithDoc[RequestType: Manifest, ResponseType: Manifest](route: String,
name: String = "",
admin: Boolean = false,
routeIndex: Option[RouteIndex] = None)
(doc: Operation => Operation)
(callback: RequestType => ResponseType): Unit = {
registerOperation(route, "options")(doc)
options(route, name, admin, routeIndex)(callback)
}
private def registerOperation(path: String, method: String)(doc: Operation => Operation): Unit = {
FinatraSwagger
.convert(swagger)
.registerOperation(prefixRoute(path), method, doc(new Operation))
}
//exact copy from Finatra RouteDSL class (it is defined as private there)
private def prefixRoute(route: String): String = {
contextWrapper {
contextVar().prefix match {
case prefix if prefix.nonEmpty && prefix.startsWith("/") => s"$prefix$route"
case prefix if prefix.nonEmpty && !prefix.startsWith("/") => s"/$prefix$route"
case _ => route
}
}
}
}
private class SwaggerRouteDSLWrapper(protected val dsl: RouteDSL)(implicit protected val swagger: Swagger) extends SwaggerRouteDSL {
override private[http] val routeBuilders = dsl.routeBuilders
override private[http] val annotations = dsl.annotations
override private[http] lazy val contextVar = dsl.contextVar
override private[http] val context = dsl.context
override private[http] def contextWrapper[T](f: => T): T = withContext(context)(f)
}
