org.scalatra.swagger

SwaggerSupportSyntax

trait SwaggerSupportSyntax extends Initializable with CorsSupport

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

Type Members

  1. trait Config extends AnyRef

  2. abstract type ConfigT

    Definition Classes
    Initializable

Abstract Value Members

  1. abstract def apiOperation[T](nickname: String)(implicit arg0: Manifest[T]): org.scalatra.swagger.SwaggerSupportSyntax.SwaggerOperationBuilder[_ <: org.scalatra.swagger.SwaggerOperation]

    Attributes
    protected
  2. abstract def applicationDescription: String

    Attributes
    protected
  3. implicit abstract def configWrapper(config: ConfigT): Config

    Attributes
    protected
    Definition Classes
    Initializable
  4. implicit abstract def swagger: org.scalatra.swagger.SwaggerEngine[_]

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. def applicationName: Option[String]

    Attributes
    protected
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def augmentSimpleRequest(): Unit

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

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

    Attributes
    protected
  11. def bodyParam(model: Model): ModelParameterBuilder

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

    Attributes
    protected
  13. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  14. implicit def dataType2string(dt: DataType): String

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

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

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

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

    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  21. 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
    CorsSupportHandler
  22. def handlePreflightRequest(): Unit

    Attributes
    protected
    Definition Classes
    CorsSupport
  23. def hashCode(): Int

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

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

    Attributes
    protected
  26. def inferSwaggerEndpoint(route: Route): String

    Attributes
    protected
  27. def initialize(config: 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
    SwaggerSupportSyntaxCorsSupportInitializable
  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  29. 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

  30. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

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

    Attributes
    protected
  34. implicit def parameterBuilder2parameter(pmb: SwaggerParameterBuilder): Parameter

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

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

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

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

    Attributes
    protected
  39. 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
  40. 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
  41. 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
  42. def swaggerDefaultErrors: List[Error]

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

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

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

    Definition Classes
    AnyRef
  46. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Deprecated Value Members

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

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

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

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

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

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

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

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

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

Inherited from CorsSupport

Inherited from Handler

Inherited from Initializable

Inherited from AnyRef

Inherited from Any