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 Product with Serializable

   

3. case class ApiInfo(title: String, description: String, termsOfServiceUrl: String, contact: ContactInfo, license: LicenseInfo) 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 AuthorizationCodeGrant(tokenRequestEndpoint: TokenRequestEndpoint, tokenEndpoint: TokenEndpoint) extends GrantType with Product with Serializable

   

7. trait AuthorizationType extends AnyRef

   

8. case class BasicAuth(keyName: String, description: String = "") extends AuthorizationType with Product with Serializable

   

9. case class ContactInfo(name: String, url: String, email: String) extends Product with Serializable

   

10. sealed trait DataType extends AnyRef

    

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

    

12. trait GrantType extends AnyRef

    

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

    

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

    

15. case class LicenseInfo(name: String, url: String) extends Product with Serializable

    

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, example: Option[String] = None, default: Option[String] = None, minimumValue: Option[Double] = None, maximumValue: Option[Double] = None, hidden: Boolean = false) 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, 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

    

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

    

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

    

24. class Swagger extends SwaggerEngine

    

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

25. trait SwaggerBase extends Initializable

    

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

26. trait SwaggerEngine extends AnyRef

    

27. trait SwaggerSupport extends ScalatraBase with SwaggerSupportBase with SwaggerSupportSyntax

    

    Provides the necessary support for adding documentation to your routes.

28. trait SwaggerSupportBase extends AnyRef

    

29. trait SwaggerSupportSyntax extends Initializable with CorsSupport

    

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

    

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