swagger

Type Members

1. trait AllowableValues extends AnyRef

2. case class Api(apiVersion: String, swaggerVersion: String, resourcePath: String, description: Option[String] = scala.None, produces: List[String] = immutable.this.Nil, consumes: List[String] = immutable.this.Nil, protocols: List[String] = immutable.this.Nil, apis: List[Endpoint] = immutable.this.Nil, models: Map[String, Model] = ..., authorizations: List[String] = immutable.this.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") extends AuthorizationType with Product with Serializable

5. case class ApiListingReference(path: String, description: Option[String] = scala.None, position: Int = 0) extends Product with Serializable

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

7. trait AuthorizationType extends AnyRef

8. sealed trait DataType extends AnyRef

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

10. trait GrantType extends AnyRef

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

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

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

14. case class Model(id: String, name: String, qualifiedName: Option[String] = scala.None, description: Option[String] = scala.None, properties: List[(String, ModelProperty)] = immutable.this.Nil, baseModel: Option[String] = scala.None, discriminator: Option[String] = scala.None) extends Product with Serializable

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

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

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

18. case class OAuth(scopes: List[String], grantTypes: List[GrantType]) extends AuthorizationType with Product with Serializable

19. case class Operation(method: HttpMethod, responseClass: DataType, summary: String, position: Int, notes: Option[String] = scala.None, deprecated: Boolean = false, nickname: Option[String] = scala.None, parameters: List[Parameter] = immutable.this.Nil, responseMessages: List[ResponseMessage[_]] = immutable.this.Nil, consumes: List[String] = immutable.this.Nil, produces: List[String] = immutable.this.Nil, protocols: List[String] = immutable.this.Nil, authorizations: List[String] = immutable.this.Nil) extends SwaggerOperation with Product with Serializable

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

21. case class ResourceListing(apiVersion: String, swaggerVersion: String = Swagger.SpecVersion, apis: List[ApiListingReference] = immutable.this.Nil, authorizations: List[AuthorizationType] = immutable.this.Nil, info: Option[ApiInfo] = scala.None) extends Product with Serializable

22. trait ResponseMessage[T] extends AnyRef

23. case class StringResponseMessage(code: Int, message: String) extends ResponseMessage[String] with 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 SwaggerBase extends SwaggerBaseBase

27. trait SwaggerBaseBase extends Initializable with ScalatraBase

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

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

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

30. trait SwaggerOperation extends AnyRef

31. trait SwaggerSupport extends ScalatraBase with SwaggerSupportBase with SwaggerSupportSyntax

    Provides the necessary support for adding documentation to your routes.

32. trait SwaggerSupportBase extends AnyRef

33. trait SwaggerSupportSyntax extends Initializable with CorsSupport

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

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