class Swagger extends SwaggerEngine
An instance of this class is used to hold the API documentation.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- Swagger
- SwaggerEngine
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAuthorization(auth: AuthorizationType): Unit
- Definition Classes
- SwaggerEngine
- val apiInfo: ApiInfo
- Definition Classes
- Swagger → SwaggerEngine
- val apiVersion: String
- Definition Classes
- Swagger → SwaggerEngine
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def authorizations: List[AuthorizationType]
- Definition Classes
- SwaggerEngine
- def baseUrlIncludeContextPath: Boolean
Configurations used by UrlGenerator when creating baseUrl.
Configurations used by UrlGenerator when creating baseUrl.
- Definition Classes
- SwaggerEngine
- def baseUrlIncludeServletPath: Boolean
- Definition Classes
- SwaggerEngine
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def doc(path: String): Option[Api]
Returns the documentation for the given path.
Returns the documentation for the given path.
- Definition Classes
- SwaggerEngine
- def docs: Iterable[Api]
- Definition Classes
- SwaggerEngine
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val extraSwaggerDefinition: Option[JValue]
- Definition Classes
- Swagger → SwaggerEngine
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val host: String
- Definition Classes
- Swagger → SwaggerEngine
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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
- val swaggerVersion: String
- Definition Classes
- Swagger → SwaggerEngine
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()