HttpRequest and HttpResponse

All 3 Akka HTTP Client API levels use the same basic model of HttpRequestHttpRequest and HttpResponseHttpResponse.

Creating requests

You can create simple GET requests:

Scala

sourceHttpRequest(uri = "https://akka.io")

// or:
import akka.http.scaladsl.client.RequestBuilding.Get
Get("https://akka.io")

// with query params
Get("https://akka.io?foo=bar")

Java

sourceHttpRequest.create("https://akka.io");

// with query params
HttpRequest.create("https://akka.io?foo=bar");

Note

HttpRequestHttpRequest alsoHttpRequestHttpRequest’s method HttpRequest::withUri() takes UriUri as a parameter. Query String in URI section describes a fluent API for building URIs with query parameters.

Or more complicated ones, like this POST:

Scala

sourceHttpRequest(
  method = HttpMethods.POST,
  uri = "https://userservice.example/users",
  entity = HttpEntity(ContentTypes.`text/plain(UTF-8)`, "data")
)

// or:
import akka.http.scaladsl.client.RequestBuilding.Post
Post("https://userservice.example/users", "data")

Java

sourceHttpRequest.POST("https://userservice.example/users")
  .withEntity(HttpEntities.create(ContentTypes.TEXT_PLAIN_UTF8, "data"));

See the API documentation of HttpRequestHttpRequest for more information on how to customize your requests.

Processing responses

When you receive a response, you can use the Marshalling API to convert the response entity into an object:

Scala

sourceimport akka.http.scaladsl.unmarshalling.Unmarshal
import akka.http.scaladsl.marshallers.sprayjson.SprayJsonSupport._
import spray.json.DefaultJsonProtocol._

case class Pet(name: String)
implicit val petFormat = jsonFormat1(Pet)

val pet: Future[Pet] = Unmarshal(response).to[Pet]

Java

sourceCompletionStage<Pet> pet = Jackson.unmarshaller(Pet.class).unmarshal(response.entity(), system);