SwaggerSupportSyntax

Type Members

trait Config extends AnyRef

Definition Classes
Initializable
abstract type ConfigT

Definition Classes
Initializable

Abstract Value Members

abstract def apiOperation[T](nickname: String)(implicit arg0: Manifest[T]): SwaggerOperationBuilder[_ <: SwaggerOperation]

Attributes
protected
abstract def applicationDescription: String

Attributes
protected
implicit abstract def configWrapper(config: (SwaggerSupportSyntax.this)#ConfigT): (SwaggerSupportSyntax.this)#Config

Attributes
protected
Definition Classes
Initializable
implicit abstract def swagger: SwaggerEngine[_]

Attributes
protected

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def applicationName: Option[String]

Attributes
protected
final def asInstanceOf[T0]: T0

Definition Classes
Any
def augmentSimpleRequest(): Unit

Attributes
protected
Definition Classes
CorsSupport
def bodyParam(name: String, model: Model): ModelParameterBuilder

Attributes
protected
def bodyParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

Attributes
protected
def bodyParam(model: Model): ModelParameterBuilder

Attributes
protected
def bodyParam[T](implicit arg0: Manifest[T]): ParameterBuilder[T]

Attributes
protected
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
implicit def dataType2string(dt: DataType): String
def description(f: PartialFunction[String, String]): Unit

Attributes
protected
def endpoint(value: String): (Route) ⇒ Route

Attributes
protected
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def handle(req: HttpServletRequest, res: HttpServletResponse): Unit

Definition Classes
CorsSupport → Handler
def handlePreflightRequest(): Unit

Attributes
protected
Definition Classes
CorsSupport
def hashCode(): Int

Definition Classes
AnyRef → Any
def headerParam(name: String, model: Model): ModelParameterBuilder

Attributes
protected
def headerParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

Attributes
protected
def inferSwaggerEndpoint(route: Route): String

Attributes
protected
def initialize(config: (SwaggerSupportSyntax.this)#ConfigT): Unit

Initializes the kernel.
Initializes the kernel. Used to provide context that is unavailable when the instance is constructed, for example the servlet lifecycle. Should set the config variable to the parameter.
config
the configuration.

Definition Classes
SwaggerSupportSyntax → CorsSupport → Initializable
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def models: Map[String, Model]

The currently registered model descriptions for swagger
The currently registered model descriptions for swagger
returns
a map of swagger models
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def operation(op: SwaggerOperation): (Route) ⇒ Route

Attributes
protected
implicit def parameterBuilder2parameter(pmb: SwaggerParameterBuilder): Parameter
def pathParam(name: String, model: Model): ModelParameterBuilder

Attributes
protected
def pathParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

Attributes
protected
def queryParam(name: String, model: Model): ModelParameterBuilder

Attributes
protected
def queryParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

Attributes
protected
def registerModel[T]()(implicit arg0: Manifest[T]): Unit

Registers a model for swagger, this method reflects over the class and collects all non-primitive classes and adds those to the swagger defintion
Registers a model for swagger, this method reflects over the class and collects all non-primitive classes and adds those to the swagger defintion
T
the class of the model to register

Attributes
protected
def registerModel(model: Model): Unit

Registers a model for swagger
Registers a model for swagger
model
the model to add to the swagger definition

Attributes
protected
def shutdown(): Unit

Attributes
protected
Definition Classes
Initializable
def swaggerDefaultErrors: List[Error]

Attributes
protected
def swaggerEndpointEntries[T <: SwaggerOperation](extract: (Route, HttpMethod) ⇒ T): Iterable[Entry[T]]

Attributes
protected
def swaggerMeta(s: Symbol, v: Any): (Route) ⇒ Route

Attributes
protected
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()

Deprecated Value Members

def errors(value: Error*): (Route) ⇒ Route

Attributes
protected
Annotations
@deprecated
Deprecated
(Since version 2.2) Use the apiOperation.errors and operation methods to build swagger descriptions of endpoints
implicit def modelToSwagger(cls: Class[_]): (String, Model)

Attributes
protected
Annotations
@deprecated
Deprecated
(Since version 2.2) This implicit conversion will be removed in the future
def models_=(m: Map[String, Model]): Map[String, Model]

Attributes
protected
Annotations
@deprecated
Deprecated
(Since version 2.2) Use registerModel[T] or registerModel(model) instead, this method will be removed in the future
def nickname(value: String): (Route) ⇒ Route

Attributes
protected
Annotations
@deprecated
Deprecated
(Since version 2.2) Use the apiOperation.nickname and operation methods to build swagger descriptions of endpoints
def notes(value: String): (Route) ⇒ Route

Attributes
protected
Annotations
@deprecated
Deprecated
(Since version 2.2) Use the apiOperation.notes and operation methods to build swagger descriptions of endpoints
def parameters(value: Parameter*): (Route) ⇒ Route

Attributes
protected
Annotations
@deprecated
Deprecated
(Since version 2.2) Use the apiOperation.parameters and operation methods to build swagger descriptions of endpoints
def responseClass[T](implicit mf: Manifest[T]): (Route) ⇒ Route

Attributes
protected
Annotations
@deprecated
Deprecated
(Since version 2.2) Use the apiOperation.responseClass and operation methods to build swagger descriptions of endpoints
def responseClass(value: String): (Route) ⇒ Route

Attributes
protected
Annotations
@deprecated
Deprecated
(Since version 2.2) Use the variant where you use a type parameter, this method doesn't allow for reflection and requires you to manually ad the model
def summary(value: String): (Route) ⇒ Route

Attributes
protected
Annotations
@deprecated
Deprecated
(Since version 2.2) Use the apiOperation.summary and operation methods to build swagger descriptions of endpoints

trait SwaggerSupportSyntax extends Initializable with CorsSupport

Type Members

trait Config extends AnyRef

abstract type ConfigT

Abstract Value Members

abstract def apiOperation[T](nickname: String)(implicit arg0: Manifest[T]): SwaggerOperationBuilder[_ <: SwaggerOperation]

abstract def applicationDescription: String

implicit abstract def configWrapper(config: (SwaggerSupportSyntax.this)#ConfigT): (SwaggerSupportSyntax.this)#Config

implicit abstract def swagger: SwaggerEngine[_]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def applicationName: Option[String]

final def asInstanceOf[T0]: T0

def augmentSimpleRequest(): Unit

def bodyParam(name: String, model: Model): ModelParameterBuilder

def bodyParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

def bodyParam(model: Model): ModelParameterBuilder

def bodyParam[T](implicit arg0: Manifest[T]): ParameterBuilder[T]

def clone(): AnyRef

implicit def dataType2string(dt: DataType): String

def description(f: PartialFunction[String, String]): Unit

def endpoint(value: String): (Route) ⇒ Route

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def handle(req: HttpServletRequest, res: HttpServletResponse): Unit

def handlePreflightRequest(): Unit

def hashCode(): Int

def headerParam(name: String, model: Model): ModelParameterBuilder

def headerParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

def inferSwaggerEndpoint(route: Route): String

def initialize(config: (SwaggerSupportSyntax.this)#ConfigT): Unit

final def isInstanceOf[T0]: Boolean

def models: Map[String, Model]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def operation(op: SwaggerOperation): (Route) ⇒ Route

implicit def parameterBuilder2parameter(pmb: SwaggerParameterBuilder): Parameter

def pathParam(name: String, model: Model): ModelParameterBuilder

def pathParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

def queryParam(name: String, model: Model): ModelParameterBuilder

def queryParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

def registerModel[T]()(implicit arg0: Manifest[T]): Unit

def registerModel(model: Model): Unit

def shutdown(): Unit

def swaggerDefaultErrors: List[Error]

def swaggerEndpointEntries[T <: SwaggerOperation](extract: (Route, HttpMethod) ⇒ T): Iterable[Entry[T]]

def swaggerMeta(s: Symbol, v: Any): (Route) ⇒ Route

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def errors(value: Error*): (Route) ⇒ Route

implicit def modelToSwagger(cls: Class[_]): (String, Model)

def models_=(m: Map[String, Model]): Map[String, Model]

def nickname(value: String): (Route) ⇒ Route

def notes(value: String): (Route) ⇒ Route

def parameters(value: Parameter*): (Route) ⇒ Route

def responseClass[T](implicit mf: Manifest[T]): (Route) ⇒ Route

def responseClass(value: String): (Route) ⇒ Route

def summary(value: String): (Route) ⇒ Route

Inherited from CorsSupport

Inherited from Handler

Inherited from Initializable

Inherited from AnyRef

Inherited from Any

Ungrouped