org.scalatra.swagger

Swagger

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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

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 addAuthorization(auth: AuthorizationType): Unit

    Definition Classes
    SwaggerEngine

  7. val apiInfo: ApiInfo

    Definition Classes
    Swagger → SwaggerEngine

  8. val apiVersion: String

    Definition Classes
    Swagger → SwaggerEngine

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def authorizations: List[AuthorizationType]

    Definition Classes
    SwaggerEngine

  11. def baseUrlIncludeContextPath: Boolean

    Configurations used by UrlGenerator when creating baseUrl.

    Configurations used by UrlGenerator when creating baseUrl.

    Definition Classes
    SwaggerEngine

  12. def baseUrlIncludeServletPath: Boolean

    Definition Classes
    SwaggerEngine

  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  14. def doc(path: String): Option[Api]

    Returns the documentation for the given path.

    Returns the documentation for the given path.

    Definition Classes
    SwaggerEngine

  15. def docs: Iterable[Api]

    Definition Classes
    SwaggerEngine

  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

  26. val swaggerVersion: String

    Definition Classes
    Swagger → SwaggerEngine

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

    Definition Classes
    AnyRef

  28. def toString(): String

    Definition Classes
    AnyRef → Any

  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SwaggerEngine[Api]

Inherited from AnyRef

Inherited from Any

Ungrouped