swagger

Type Members

1. trait AllowableValues extends AnyRef

   

2. 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 SwaggerApi[Endpoint] with Product with Serializable

   

3. case class ApiInfo(title: String, description: String, termsOfServiceUrl: String, contact: String, license: String, licenseUrl: String) extends Product with Serializable

   

4. case class ApiKey(keyname: String, passAs: String = "header", description: String = "") extends AuthorizationType with Product with Serializable

   

5. case class ApplicationGrant(tokenEndpoint: TokenEndpoint) extends GrantType with Product with Serializable

   

6. case class AuthApi[TypeForUser <: AnyRef](apiVersion: String, swaggerVersion: String, resourcePath: String, description: Option[String] = None, produces: List[String] = Nil, consumes: List[String] = Nil, protocols: List[String] = Nil, apis: List[AuthEndpoint[TypeForUser]] = Nil, models: Map[String, Model] = Map.empty, authorizations: List[String] = Nil, position: Int = 0) extends SwaggerApi[AuthEndpoint[TypeForUser]] with Product with Serializable

   

7. case class AuthEndpoint[TypeForUser <: AnyRef](path: String, description: Option[String] = None, operations: List[AuthOperation[TypeForUser]] = Nil) extends SwaggerEndpoint[AuthOperation[TypeForUser]] with Product with Serializable

   

8. case class AuthOperation[TypeForUser <: AnyRef](method: HttpMethod, responseClass: DataType, summary: String, position: Int, description: Option[String] = None, deprecated: Boolean = false, operationId: Option[String] = None, 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, allows: (Option[TypeForUser]) ⇒ Boolean = (_: Option[TypeForUser]) => true) extends SwaggerOperation with Product with Serializable

   

9. case class AuthorizationCodeGrant(tokenRequestEndpoint: TokenRequestEndpoint, tokenEndpoint: TokenEndpoint) extends GrantType with Product with Serializable

   

10. trait AuthorizationType extends AnyRef

    

11. sealed trait DataType extends AnyRef

    

12. case class Endpoint(path: String, description: Option[String] = None, operations: List[Operation] = Nil) extends SwaggerEndpoint[Operation] with Product with Serializable

    

13. trait GrantType extends AnyRef

    

14. case class ImplicitGrant(loginEndpoint: LoginEndpoint, tokenName: String) extends GrantType with Product with Serializable

    

15. trait JacksonSwaggerBase extends ScalatraBase with JacksonJsonSupport with CorsSupport with SwaggerBase

    

16. case class LoginEndpoint(url: String) extends Product with Serializable

    

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

    

18. case class ModelProperty(type: DataType, position: Int = 0, required: Boolean = false, description: Option[String] = None, allowableValues: AllowableValues = AllowableValues.AnyValue, items: Option[ModelRef] = None) extends Product with Serializable

    

19. trait NativeSwaggerBase extends ScalatraBase with NativeJsonSupport with CorsSupport with SwaggerBase

    

20. case class OAuth(scopes: List[String], grantTypes: List[GrantType], keyname: String = "oauth2", description: String = "") extends AuthorizationType with Product with Serializable

    

21. case class Operation(method: HttpMethod, responseClass: DataType, summary: String, position: Int, description: Option[String] = None, deprecated: Boolean = false, operationId: Option[String] = None, 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 SwaggerOperation with Product with Serializable

    

22. case class Parameter(name: String, type: DataType, description: Option[String] = None, notes: Option[String] = None, paramType: ParamType = ParamType.Query, defaultValue: Option[String] = None, allowableValues: AllowableValues = AllowableValues.AnyValue, required: Boolean = true, paramAccess: Option[String] = None, position: Int = 0) extends Product with Serializable

    

23. case class ResponseMessage(code: Int, message: String, responseModel: Option[String] = None) extends Product with Serializable

    

24. class Swagger extends SwaggerEngine[Api]

    

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

25. trait SwaggerApi[T <: SwaggerEndpoint[_]] extends AnyRef

    

26. trait SwaggerAuthBase[TypeForUser <: AnyRef] extends SwaggerBaseBase

    

27. trait SwaggerAuthSupport[TypeForUser <: AnyRef] extends SwaggerSupportBase with SwaggerSupportSyntax

    

28. trait SwaggerBase extends SwaggerBaseBase

    

29. trait SwaggerBaseBase extends Initializable with ScalatraBase

    

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

30. trait SwaggerEndpoint[T <: SwaggerOperation] extends AnyRef

    

31. trait SwaggerEngine[T <: SwaggerApi[_]] extends AnyRef

    

32. trait SwaggerOperation extends AnyRef

    

33. trait SwaggerSupport extends ScalatraBase with SwaggerSupportBase with SwaggerSupportSyntax

    

    Provides the necessary support for adding documentation to your routes.

34. trait SwaggerSupportBase extends AnyRef

    

35. trait SwaggerSupportSyntax extends Initializable with CorsSupport

    

36. class SwaggerWithAuth extends SwaggerEngine[AuthApi[AnyRef]]

    

37. case class TokenEndpoint(url: String, tokenName: String) extends Product with Serializable

    

38. case class TokenRequestEndpoint(url: String, clientIdName: String, clientSecretName: String) extends Product with Serializable

    

39. case class ModelRef(type: String, ref: Option[String] = None, qualifiedType: Option[String] = None) extends Product with Serializable

    

    Annotations

    @deprecated

    Deprecated

    (Since version 2.6.0) This class has been removed in Swagger 2.0.

40. trait SwaggerCommandSupport extends AnyRef

    

    Annotations

    @deprecated

    Deprecated

    (Since version 2.6.0) scalatra-command is deprecated.