package swagger
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- swagger
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
- trait AllowableValues extends AnyRef
- case class Api(apiVersion: String, swaggerVersion: String, resourcePath: String, description: Option[String] = None, produces: List[String] = Nil, consumes: List[String] = Nil, protocols: List[String] = Nil, apis: List[Endpoint] = Nil, models: Map[String, Model] = Map.empty, authorizations: List[String] = Nil, position: Int = 0) extends Product with Serializable
- case class ApiInfo(title: String, description: String, termsOfServiceUrl: String, contact: ContactInfo, license: LicenseInfo) extends Product with Serializable
- case class ApiKey(keyName: String, passAs: String = "header", description: String = "") extends AuthorizationType with Product with Serializable
- case class ApplicationGrant(tokenEndpoint: TokenEndpoint) extends GrantType with Product with Serializable
- case class AuthorizationCodeGrant(tokenRequestEndpoint: TokenRequestEndpoint, tokenEndpoint: TokenEndpoint) extends GrantType with Product with Serializable
- trait AuthorizationType extends AnyRef
- case class BasicAuth(keyName: String, description: String = "") extends AuthorizationType with Product with Serializable
- case class ContactInfo(name: String, url: String, email: String) extends Product with Serializable
- sealed trait DataType extends AnyRef
- case class Endpoint(path: String, description: Option[String] = None, operations: List[Operation] = Nil) extends Product with Serializable
- trait GrantType extends AnyRef
- case class ImplicitGrant(loginEndpoint: LoginEndpoint, tokenName: String) extends GrantType with Product with Serializable
- trait JacksonSwaggerBase extends ScalatraBase with JacksonJsonSupport with CorsSupport with SwaggerBase
- case class LicenseInfo(name: String, url: String) extends Product with Serializable
- case class LoginEndpoint(url: String) extends Product with Serializable
- case class Model(id: String, name: String, qualifiedName: Option[String] = None, description: Option[String] = None, properties: List[(String, ModelProperty)] = Nil, baseModel: Option[String] = None, discriminator: Option[String] = None) extends Product with Serializable
- case class ModelProperty(type: DataType, position: Int = 0, required: Boolean = false, description: Option[String] = None, allowableValues: AllowableValues = AllowableValues.AnyValue, example: Option[String] = None, default: Option[String] = None, minimumValue: Option[Double] = None, maximumValue: Option[Double] = None, hidden: Boolean = false) extends Product with Serializable
- trait NativeSwaggerBase extends ScalatraBase with NativeJsonSupport with CorsSupport with SwaggerBase
- case class OAuth(scopes: List[String], grantTypes: List[GrantType], keyName: String = "oauth2", description: String = "") extends AuthorizationType with Product with Serializable
- case class Operation(method: HttpMethod, operationId: String, responseClass: DataType, summary: String, position: Int, description: Option[String] = None, deprecated: Boolean = false, parameters: List[Parameter] = Nil, responseMessages: List[ResponseMessage] = Nil, consumes: List[String] = Nil, produces: List[String] = Nil, schemes: List[String] = Nil, authorizations: List[String] = Nil, tags: List[String] = Nil) extends Product with Serializable
- case class Parameter(name: String, type: DataType, description: Option[String] = None, paramType: ParamType = ParamType.Query, defaultValue: Option[String] = None, allowableValues: AllowableValues = AllowableValues.AnyValue, required: Boolean = true, position: Int = 0, example: Option[String] = None, minimumValue: Option[Double] = None, maximumValue: Option[Double] = None, hidden: Boolean = false) extends Product with Serializable
- case class ResponseMessage(code: Int, message: String, responseModel: Option[String] = None) extends Product with Serializable
-
class
Swagger extends SwaggerEngine
An instance of this class is used to hold the API documentation.
-
trait
SwaggerBase extends Initializable
Trait that serves the resource and operation listings, as specified by the Swagger specification.
- trait SwaggerEngine extends AnyRef
-
trait
SwaggerSupport extends ScalatraBase with SwaggerSupportBase with SwaggerSupportSyntax
Provides the necessary support for adding documentation to your routes.
- trait SwaggerSupportBase extends AnyRef
- trait SwaggerSupportSyntax extends Initializable with CorsSupport
- case class TokenEndpoint(url: String, tokenName: String) extends Product with Serializable
- case class TokenRequestEndpoint(url: String, clientIdName: String, clientSecretName: String) extends Product with Serializable
Value Members
- object AllowableValues
- object DataType
- object ParamType extends Enumeration
- object Swagger
- object SwaggerSupportSyntax
- object Symbols
- object annotations