Class/Object

org.scalatra.swagger

Swagger

Related Docs: object Swagger | package swagger

Permalink

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)

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def addAuthorization(auth: AuthorizationType): Unit

    Permalink
    Definition Classes
    SwaggerEngine

  5. val apiInfo: ApiInfo

    Permalink
    Definition Classes
    Swagger → SwaggerEngine

  6. val apiVersion: String

    Permalink
    Definition Classes
    Swagger → SwaggerEngine

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def authorizations: List[AuthorizationType]

    Permalink
    Definition Classes
    SwaggerEngine

  9. def baseUrlIncludeContextPath: Boolean

    Permalink

    Configurations used by UrlGenerator when creating baseUrl.

    Configurations used by UrlGenerator when creating baseUrl.

    Definition Classes
    SwaggerEngine

  10. def baseUrlIncludeServletPath: Boolean

    Permalink
    Definition Classes
    SwaggerEngine

  11. def clone(): AnyRef

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

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

    Permalink

    Returns the documentation for the given path.

    Returns the documentation for the given path.

    Definition Classes
    SwaggerEngine

  13. def docs: Iterable[Api]

    Permalink
    Definition Classes
    SwaggerEngine

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

    Permalink
    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    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

    Permalink

    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

    Permalink
    Definition Classes
    Swagger → SwaggerEngine

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

    Permalink
    Definition Classes
    AnyRef

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SwaggerEngine[Api]

Inherited from AnyRef

Inherited from Any

Ungrouped