trait SwaggerSupportSyntax extends Initializable with CorsSupport

Self Type
SwaggerSupportSyntax with ScalatraBase with SwaggerSupportBase
Linear Supertypes
CorsSupport, Handler, Initializable, AnyRef, Any
Known Subclasses
SwaggerAuthSupport, SwaggerSupport
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwaggerSupportSyntax
  2. CorsSupport
  3. Handler
  4. Initializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef
    Definition Classes
    Initializable
  2. abstract type ConfigT
    Definition Classes
    Initializable
  3. implicit class ResponseMessageWithModel extends AnyRef

Abstract Value Members

  1. abstract def apiOperation[T](nickname: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): SwaggerOperationBuilder[_ <: SwaggerOperation]
    Attributes
    protected
  2. abstract def applicationDescription: String
    Attributes
    protected
  3. implicit abstract def configWrapper(config: (SwaggerSupportSyntax.this)#ConfigT): (SwaggerSupportSyntax.this)#Config
    Attributes
    protected
    Definition Classes
    Initializable
  4. implicit abstract def swagger: SwaggerEngine[_]
    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def augmentSimpleRequest(): Unit
    Attributes
    protected
    Definition Classes
    CorsSupport
  6. def bodyParam(name: String, model: Model): ModelParameterBuilder
    Attributes
    protected
  7. def bodyParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
  8. def bodyParam(model: Model): ModelParameterBuilder
    Attributes
    protected
  9. def bodyParam[T](implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. implicit def dataType2string(dt: DataType): String
  12. def description(f: PartialFunction[String, String]): Unit
    Attributes
    protected
  13. def endpoint(value: String): RouteTransformer
    Attributes
    protected
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formParam(name: String, model: Model): ModelParameterBuilder
    Attributes
    protected
  18. def formParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  20. def handle(req: HttpServletRequest, res: HttpServletResponse): Unit

    Handles a request and writes to the response.

    Handles a request and writes to the response.

    Definition Classes
    CorsSupport → Handler
  21. def handlePreflightRequest(): Unit
    Attributes
    protected
    Definition Classes
    CorsSupport
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  23. def headerParam(name: String, model: Model): ModelParameterBuilder
    Attributes
    protected
  24. def headerParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
  25. def inferSwaggerEndpoint(route: Route): String
    Attributes
    protected
  26. 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
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. 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

  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  32. def operation(op: SwaggerOperation): RouteTransformer
    Attributes
    protected
  33. implicit def parameterBuilder2parameter(pmb: SwaggerParameterBuilder): Parameter
  34. def pathParam(name: String, model: Model): ModelParameterBuilder
    Attributes
    protected
  35. def pathParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
  36. def queryParam(name: String, model: Model): ModelParameterBuilder
    Attributes
    protected
  37. def queryParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
  38. def registerModel[T]()(implicit arg0: Manifest[T], arg1: NotNothing[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
  39. 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
  40. def shutdown(): Unit

    A hook to shutdown the class.

    A hook to shutdown the class. Bridges the gap between servlet's destroy and filter's destroy.

    Attributes
    protected
    Definition Classes
    Initializable
  41. def swaggerAuthorizations: List[String]
    Attributes
    protected
  42. def swaggerConsumes: List[String]
    Attributes
    protected
  43. def swaggerDefaultMessages: List[ResponseMessage]
    Attributes
    protected
  44. def swaggerEndpointEntries[T <: SwaggerOperation](extract: (Route, HttpMethod) ⇒ T): Iterable[Entry[T]]
    Attributes
    protected
  45. def swaggerMeta(s: Symbol, v: Any): RouteTransformer
    Attributes
    protected
  46. def swaggerProduces: List[String]
    Attributes
    protected
  47. def swaggerProtocols: List[String]
    Attributes
    protected
  48. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  49. def toString(): String
    Definition Classes
    AnyRef → Any
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def applicationName: Option[String]
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.1) This field is no longer used, due to changes in Swagger spec 1.2

  2. def errors(value: Error*): RouteTransformer
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.errors and operation methods to build swagger descriptions of endpoints

  3. 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

  4. 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

  5. def nickname(value: String): RouteTransformer
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.nickname and operation methods to build swagger descriptions of endpoints

  6. def notes(value: String): RouteTransformer
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.notes and operation methods to build swagger descriptions of endpoints

  7. def parameters(value: Parameter*): RouteTransformer
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.parameters and operation methods to build swagger descriptions of endpoints

  8. def responseClass[T](implicit mf: Manifest[T]): RouteTransformer
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.responseClass and operation methods to build swagger descriptions of endpoints

  9. def responseClass(value: String): RouteTransformer
    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

  10. def summary(value: String): RouteTransformer
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.summary and operation methods to build swagger descriptions of endpoints

  11. def swaggerDefaultErrors: List[ResponseMessage]
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2.2) Swagger spec 1.2 renamed this to swaggerDefaultMessages, please use that one

Inherited from CorsSupport

Inherited from Handler

Inherited from Initializable

Inherited from AnyRef

Inherited from Any

Ungrouped