Api

Provides the main api for creating and sending REST Web service requests (as an object for importing).

val request = Request(GET, new URI("http://api.rest.org/person", Map(), None))
val response = driver.execute(request)
response.statusCode should be(Status.OK)
response.body match {
  Some(body) => objectMapper.readValue[List[Person]](body) should have length(0)
  None => fail("Expected a body"))
}

or using the Api.RequestBuilder

val request = driver.execute(RequestBuilder().withUrl("http://api.rest.org/person/").withMethod(GET))

This provides the basic interface used to implement the Dsl, users are expected to use the Dsl.

Linear Supertypes

AnyRef, Any

Type Members

type HttpClient = (Request) ⇒ Response

Abstract interface for submitting REST Requests and receiving Responses
sealed abstract class Method extends AnyRef

HTTP Method
case class Request(method: Method, url: URI, headers: Map[String, List[String]] = Map(), body: Option[String] = None) extends Product with Serializable

The HTTP Request
case class RequestBuilder(method: Option[Method], url: Option[URI], query: Seq[(String, String)], headers: Seq[(String, String)], queryParams: Seq[(String, String)], body: Option[String]) extends Product with Serializable

Builder to make creating Request objects nicer - normally this should be driven through the Dsl.
case class Response(statusCode: Int, headers: Map[String, List[String]], body: Option[String]) extends Product with Serializable

The HTTP Response

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object DELETE extends Method with Product with Serializable

HTTP delete method
object GET extends Method with Product with Serializable

HTTP get method
object HEAD extends Method with Product with Serializable

HTTP head method
object PATCH extends Method with Product with Serializable

HTTP patch method
object POST extends Method with Product with Serializable

HTTP post method
object PUT extends Method with Product with Serializable

HTTP put method
object RequestBuilder extends Serializable

Helper object for RequestBuilder class, supplies the emptyBuilder instance and access to the current implicit builder.
object Status

Constants for HTTP Status Codes
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toHeaders(hs: (String, String)*): Map[String, List[String]]

Convert a sequence of (name, value) tuples into a map of headers.
Convert a sequence of (name, value) tuples into a map of headers. Each tuple creates an entry in the map, duplicate names add the value to the list.
def toQueryString(qs: (String, String)*): String
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: trait Api | package resttest

object Api

Type Members

type HttpClient = (Request) ⇒ Response

sealed abstract class Method extends AnyRef

case class Request(method: Method, url: URI, headers: Map[String, List[String]] = Map(), body: Option[String] = None) extends Product with Serializable

case class RequestBuilder(method: Option[Method], url: Option[URI], query: Seq[(String, String)], headers: Seq[(String, String)], queryParams: Seq[(String, String)], body: Option[String]) extends Product with Serializable

case class Response(statusCode: Int, headers: Map[String, List[String]], body: Option[String]) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object DELETE extends Method with Product with Serializable

object GET extends Method with Product with Serializable

object HEAD extends Method with Product with Serializable

object PATCH extends Method with Product with Serializable

object POST extends Method with Product with Serializable

object PUT extends Method with Product with Serializable

object RequestBuilder extends Serializable

object Status

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toHeaders(hs: (String, String)*): Map[String, List[String]]

def toQueryString(qs: (String, String)*): String

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped