scalatra-swagger-javax
API
Generated with
scalatra-swagger-javax/org.scalatra.swagger

org.scalatra.swagger

package org.scalatra.swagger

Members list

Packages

package org.scalatra.swagger.reflect

Type members

Classlikes

trait AllowableValues

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AnyValue.type
object AllowableValues

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class Api(apiVersion: String, swaggerVersion: String, resourcePath: String, description: Option[String], produces: List[String], consumes: List[String], protocols: List[String], apis: List[Endpoint], models: Map[String, Model], authorizations: List[String], position: Int)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ApiInfo(title: String, description: String, termsOfServiceUrl: String, contact: ContactInfo, license: LicenseInfo)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ApiKey(keyName: String, passAs: String, description: String) extends AuthorizationType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ApplicationGrant(tokenEndpoint: TokenEndpoint) extends GrantType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GrantType
class Object
trait Matchable
class Any
Show all
case class AuthorizationCodeGrant(tokenRequestEndpoint: TokenRequestEndpoint, tokenEndpoint: TokenEndpoint) extends GrantType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GrantType
class Object
trait Matchable
class Any
Show all
trait AuthorizationType

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ApiKey
class BasicAuth
class OAuth
case class BasicAuth(keyName: String, description: String) extends AuthorizationType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ContactInfo(name: String, url: String, email: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait DataType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DataType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
DataType.type
case class Endpoint(path: String, description: Option[String], operations: List[Operation])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait GrantType

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ImplicitGrant(loginEndpoint: LoginEndpoint, tokenName: String) extends GrantType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GrantType
class Object
trait Matchable
class Any
Show all
trait JacksonSwaggerBase extends ScalatraBase, JacksonJsonSupport, CorsSupport, SwaggerBase

Attributes

Supertypes
trait SwaggerBase
trait CorsSupport
trait JacksonJsonSupport
trait JValueResult
trait JacksonJsonOutput
trait JsonMethods
trait JsonSupport[JValue]
trait JsonOutput[JValue]
trait JsonMethods[JValue]
trait ApiFormats
trait ScalatraBase
trait DefaultImplicitConversions
trait LowPriorityImplicitConversions
trait LowestPriorityImplicitConversions
trait TypeConverterSupport
trait ScalatraParamsImplicits
trait Initializable
trait DynamicScope
trait RequestResponseScope
trait CoreDsl
trait Control
trait Handler
trait ScalatraContext
trait CookieContext
trait SessionSupport
trait ServletApiImplicits
class Object
trait Matchable
class Any
Show all
case class LicenseInfo(name: String, url: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class LoginEndpoint(url: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Model(id: String, name: String, qualifiedName: Option[String], description: Option[String], properties: List[(String, ModelProperty)], baseModel: Option[String], discriminator: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ModelProperty(`type`: DataType, position: Int, required: Boolean, description: Option[String], allowableValues: AllowableValues, example: Option[String], default: Option[String], minimumValue: Option[Double], maximumValue: Option[Double], hidden: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait NativeSwaggerBase extends ScalatraBase, NativeJsonSupport, CorsSupport, SwaggerBase

Attributes

Supertypes
trait SwaggerBase
trait CorsSupport
trait NativeJsonSupport
trait JValueResult
trait NativeJsonOutput
trait JsonMethods
trait JsonSupport[Document]
trait JsonOutput[Document]
trait JsonMethods[Document]
trait ApiFormats
trait ScalatraBase
trait DefaultImplicitConversions
trait LowPriorityImplicitConversions
trait LowestPriorityImplicitConversions
trait TypeConverterSupport
trait ScalatraParamsImplicits
trait Initializable
trait DynamicScope
trait RequestResponseScope
trait CoreDsl
trait Control
trait Handler
trait ScalatraContext
trait CookieContext
trait SessionSupport
trait ServletApiImplicits
class Object
trait Matchable
class Any
Show all
case class OAuth(scopes: List[String], grantTypes: List[GrantType], keyName: String, description: String) extends AuthorizationType

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Operation(method: HttpMethod, operationId: String, responseClass: DataType, summary: String, position: Int, description: Option[String], deprecated: Boolean, parameters: List[Parameter], responseMessages: List[ResponseMessage], consumes: List[String], produces: List[String], schemes: List[String], authorizations: List[String], tags: List[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ParamType extends Enumeration

Attributes

Supertypes
class Enumeration
trait Serializable
class Object
trait Matchable
class Any
Self type
ParamType.type
case class Parameter(name: String, `type`: DataType, description: Option[String], paramType: ParamType, defaultValue: Option[String], allowableValues: AllowableValues, required: Boolean, position: Int, example: Option[String], minimumValue: Option[Double], maximumValue: Option[Double], hidden: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ResponseMessage(code: Int, message: String, responseModel: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Swagger

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Swagger.type
class Swagger(val swaggerVersion: String, val apiVersion: String, val apiInfo: ApiInfo, val host: String, val extraSwaggerDefinition: Option[JValue]) extends SwaggerEngine

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

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
trait SwaggerBase extends Initializable

Trait that serves the resource and operation listings, as specified by the Swagger specification.

Trait that serves the resource and operation listings, as specified by the Swagger specification.

Attributes

Supertypes
trait Initializable
class Object
trait Matchable
class Any
Known subtypes
Self type
ScalatraBase & JsonSupport[_] & CorsSupport
trait SwaggerEngine

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Swagger
trait SwaggerSupport extends ScalatraBase, SwaggerSupportBase, SwaggerSupportSyntax

Provides the necessary support for adding documentation to your routes.

Provides the necessary support for adding documentation to your routes.

Attributes

Supertypes
trait CorsSupport
trait ScalatraBase
trait DefaultImplicitConversions
trait LowPriorityImplicitConversions
trait LowestPriorityImplicitConversions
trait TypeConverterSupport
trait ScalatraParamsImplicits
trait Initializable
trait DynamicScope
trait RequestResponseScope
trait CoreDsl
trait Control
trait Handler
trait ScalatraContext
trait CookieContext
trait SessionSupport
trait ServletApiImplicits
class Object
trait Matchable
class Any
Show all
trait SwaggerSupportBase

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object SwaggerSupportSyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait SwaggerSupportSyntax extends Initializable, CorsSupport

Attributes

Companion
object
Supertypes
trait CorsSupport
trait Handler
trait Initializable
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type
ScalatraBase & SwaggerSupportBase
object Symbols

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Symbols.type
case class TokenEndpoint(url: String, tokenName: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TokenRequestEndpoint(url: String, clientIdName: String, clientSecretName: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object annotations

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Generated with