class Swagger extends SwaggerEngine[Api]

An instance of this class is used to hold the API documentation.

Linear Supertypes
SwaggerEngine[Api], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Swagger
  2. SwaggerEngine
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Swagger(swaggerVersion: String, apiVersion: String, apiInfo: ApiInfo)

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. def addAuthorization(auth: AuthorizationType): Unit
    Definition Classes
    SwaggerEngine
  5. val apiInfo: ApiInfo
    Definition Classes
    Swagger → SwaggerEngine
  6. val apiVersion: String
    Definition Classes
    Swagger → SwaggerEngine
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def authorizations: List[AuthorizationType]
    Definition Classes
    SwaggerEngine
  9. def baseUrlIncludeContextPath: Boolean

    Configurations used by UrlGenerator when creating baseUrl.

    Configurations used by UrlGenerator when creating baseUrl.

    Definition Classes
    SwaggerEngine
  10. def baseUrlIncludeServletPath: Boolean
    Definition Classes
    SwaggerEngine
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def doc(path: String): Option[Api]

    Returns the documentation for the given path.

    Returns the documentation for the given path.

    Definition Classes
    SwaggerEngine
  13. def docs: Iterable[Api]
    Definition Classes
    SwaggerEngine
  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. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  23. def register(listingPath: String, resourcePath: String, description: Option[String], s: SwaggerSupportSyntax with SwaggerSupportBase, consumes: List[String], produces: List[String], protocols: List[String], authorizations: List[String]): Unit

    Registers the documentation for an API with the given path.

    Registers the documentation for an API with the given path.

    Definition Classes
    Swagger → SwaggerEngine
  24. val swaggerVersion: String
    Definition Classes
    Swagger → SwaggerEngine
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SwaggerEngine[Api]

Inherited from AnyRef

Inherited from Any

Ungrouped