play.api.libs.ws

JSON, XML and Multipart Form Data Readables used for Play-WS bodies.

JSON, XML and Multipart Form Data Writables used for Play-WS bodies.

A Play specific WS client that can use Play specific classes in the request and response building.

Typically, access this class through dependency injection, i.e.

 class MyService @Inject()(ws: WSClient) {
   val response: Future[WSResponse] = ws.url("https://example.com").get()
 }

Please see the documentation at https://www.playframework.com/documentation/latest/ScalaWS for more details.

A WS Request builder.

A WS Response that can use Play specific classes.

Converts a response body into Array[Byte].

import play.api.libs.ws.DefaultBodyReadables._

def example(response: play.api.libs.ws.StandaloneWSResponse): Array[Byte] =
 response.body[Array[Byte]]

Converts a response body into a read only ByteBuffer.

import java.nio.ByteBuffer
import play.api.libs.ws.DefaultBodyReadables._

def example(response: play.api.libs.ws.StandaloneWSResponse): ByteBuffer =
 response.body[ByteBuffer]

Converts a response body into an akka.util.ByteString:

import akka.util.ByteString
import play.api.libs.ws.DefaultBodyReadables._

def example(response: play.api.libs.ws.StandaloneWSResponse): ByteString =
 response.body[ByteString]

Converts a response body into Play JSON format:

import play.api.libs.ws.StandaloneWSResponse
import play.api.libs.ws.JsonBodyReadables._

def json(r: StandaloneWSResponse) = r.body[play.api.libs.json.JsValue]

Converts a response body into Source[ByteString, _].

Converts a response body into a String.

Note: this is only a best-guess effort and does not handle all content types. See StandaloneWSResponse.body:String* for more information.

import play.api.libs.ws.DefaultBodyReadables._

def example(response: play.api.libs.ws.StandaloneWSResponse): String =
 response.body[String]

Converts a response body into XML document:

import scala.xml.Elem

import play.api.libs.ws.StandaloneWSResponse
import play.api.libs.ws.XMLBodyReadables._

def foo(resp: StandaloneWSResponse): Elem = resp.body[Elem]

Creates an SourceBody with "application/octet-stream" content type from a file.

Creates an SourceBody with "application/octet-stream" content type from an inputstream.

Creates an SourceBody with "application/octet-stream" content type from a file.

Creates an InMemoryBody with "application/octet-stream" content type from an array of bytes.

Creates an InMemoryBody with "application/octet-stream" content type from a bytebuffer.

Creates an InMemoryBody with "application/octet-stream" content type.

Creates an InMemoryBody with "text/xml" content type.

Creates an InMemoryBody with "application/json" content type, using the static ObjectMapper.

Creates an InMemoryBody with "text/xml" content type.

Creates an InMemoryBody with "text/xml" content type.

Creates an InMemoryBody with "text/plain" content type.

Creates an InMemoryBody with "text/plain" content type from a StringBuilder

Creates a BodyWritable with an identity function, with "application/octet-stream" content type.

Creates an InMemoryBody with "application/x-www-form-urlencoded" content type.