Packages

•  package root

  Provided herein is API documentation for Scamper, the HTTP library for Scala.

  Provided herein is API documentation for Scamper, the HTTP library for Scala.

  Definition Classes

  root

•  package scamper

  Defines core types.

  Defines core types.

  HTTP Messages

  At the core of Scamper is HttpMessage, which is a trait that defines the fundamental characteristics of an HTTP message. HttpRequest and HttpResponse extend the specification to define characteristics specific to their respective message types.

  An HttpRequest is created using a factory method defined in its companion object. Or you can start with a RequestMethod and use builder methods to further define the request.

  import scamper.Header
  import scamper.Implicits.stringToUri
  import scamper.RequestMethod.Registry.Get
  
  val request = Get("/motd").setHeaders(
    Header("Host: localhost:8080"),
    Header("Accept: text/plain")
  )
  
  printf("Request Method: %s%n", request.method)
  printf("Target URI: %s%n", request.target)
  
  request.headers.foreach(println)
  
  val host: Option[String] = request.getHeaderValue("Host")

  An HttpResponse is created using a factory method defined in its companion object. Or you can start with a ResponseStatus and use builder methods to further define the response.

  import scamper.{ BodyParser, Header }
  import scamper.Implicits.stringToEntity
  import scamper.ResponseStatus.Registry.Ok
  
  val response = Ok("There is an answer.").setHeaders(
    Header("Content-Type: text/plain"),
    Header("Connection: close")
  )
  
  printf("Status Code: %s%n", response.statusCode)
  printf("Reason Phrase: %s%n", response.reasonPhrase)
  
  response.headers.foreach(println)
  
  val contentType: Option[String] = response.getHeaderValue("Content-Type")
  
  implicit val parser = BodyParser.text()
  
  printf("Body: %s%n", response.as[String])

  Definition Classes

  root

•  package types

  Defines standard types for header values.

  Defines standard types for header values.

  import scamper.Implicits.{ stringToEntity, stringToUri }
  import scamper.RequestMethod.Registry.Get
  import scamper.ResponseStatus.Registry.Ok
  import scamper.headers.{ Accept, ContentType, TransferEncoding }
  import scamper.types.{ MediaRange, MediaType, TransferCoding }
  
  val json = MediaRange("application", "json", 0.9f)
  val html = MediaRange("text/html; q=0.1")
  
  val req = Get("/motd")
    .setAccept(json, html)
  
  val text = MediaType("text/plain")
  val gzip = TransferCoding("gzip")
  
  val res = Ok("There is an answer.")
    .setContentType(text)
    .setTransferEncoding(gzip)

  Using values defined in Implicits, properly formatted strings can be implicitly converted to standardized types.

  import scamper.Implicits.{ stringToEntity, stringToUri }
  import scamper.RequestMethod.Registry.Get
  import scamper.ResponseStatus.Registry.Ok
  import scamper.headers.{ Accept, ContentType, TransferEncoding }
  import scamper.types.Implicits._
  
  val req = Get("/motd")
    .setAccept("application/json; q=0.9", "text/html; q=0.1")
  
  val res = Ok("There is an answer.")
    .setContentType("text/plain")
    .setTransferEncoding("gzip")

  Definition Classes

  scamper

  See also

  scamper.headers

•  case object CacheDirectives extends Product with Serializable

  Provides registered cache directives.

  Provides registered cache directives.

  Definition Classes

  types

• immutable
• max-age
• max-stale
• min-fresh
• must-revalidate
• no-cache
• no-store
• no-transform
• only-if-cached
• private
• proxy-revalidate
• public
• s-maxage
• stale-if-error
• stale-while-revalidate

scamper.types.CacheDirectives

s-maxage