|
|
# sttp
The HTTP client for Scala that you always wanted
```scala
val user = "adamw"
val state = "closed"
val sort: Option[String] = None
val request = sttp.get(uri"https://api.github.com/repos/$user/elasticmq/issues?state=$state&sort=$sort")
val response = request.send(responseAsString("utf-8"))
println(response.header("Content-Length")) // has type Option[String]
println(response.body) // has type String as specified when sending the request
```
## Goals of the project
* provide a simple, discoverable, no-surprises, reasonably type-safe API for making HTTP requests
* separate definition of a request from request execution
* provide immutable, easily modifiable data structures for requests and responses
* support both synchronous and asynchronous execution backends
* provide support for backend-specific request/response streaming
## How is sttp different from other libraries?
* immutable request builder which doesn't impose any order in which request parameters need to be specified.
One consequence of that approach is that the URI doesn't need to be specified upfront. Allows defining partial requests
which contain common cookies/headers/options, which can later be specialized using a specific URI and HTTP method.
* support for multiple backends, both synchronous and asynchronous, with backend-specific streaming support
* URI interpolator with optional parameters support
## Usage
First, make sure to import:
```scala
import com.softwaremill.sttp._
```
To send requests, you will also need a backend. A default, synchronous backend based on Java's `HttpURLConnection`
is provided out-of-the box. An implicit value needs to be in scope to invoke `send()` (however it's possible to
create request descriptions without any implicit backend in scope):
```scala
implicit val handler = HttpConnectionSttpHandler
```
Any request definition starts from `sttp`: the empty request. This can be further customised, each time yielding a new,
immutable request description (unless a mutable body is set on the request, such as a byte array).
## URI interpolator
Using the URI interpolator it's possible to conveniently create `java.net.URI` instances, which can then be used
to specify request endpoints, for example:
```scala
import com.softwaremill.sttp._
import java.net.URI
val user = "Mary Smith"
val filter = "programming languages"
val endpoint: URI = uri"http://example.com/$user/skills?filter=$filter"
```
Any values embedded in the URI will be URL-encoded, taking into account the context (e.g., the whitespace in `user` will
be %-encoded as `%20D`, while the whitespace in `filter` will be query-encoded as `+`).
The possibilities of the interpolator don't end here. Other supported features:
* parameters can have optional values: if the value of a parameter is `None`, it will be removed
* maps, sequences of tuples and sequences of values can be embedded in the query part. They will be expanded into
query parameters. Maps and sequences of tuples can also contain optional values, for which mappings will be removed
if `None`.
* optional values in the host part will be expanded to a subdomain if `Some`, removed if `None`
* sequences in the host part will be expanded to a subdomain sequence
* if a string contains the protocol is embedded *as the first element*, it will not be escaped, allowing to specialize
entire addresses, e.g.: `uri"$endpoint/login"`, where `val endpoint = "http://example.com/api"`.
A fully-featured example:
```scala
import com.softwaremill.sttp._
val secure = true
val scheme = if (secure) "https" else "http"
val subdomains = List("sub1", "sub2")
val vx = Some("y z")
val params = Map("a" -> 1, "b" -> 2)
val jumpTo = Some("section2")
uri"$scheme://$subdomains.example.com?x=$vx&$params#$jumpTo"
// generates:
// https://sub1.sub2.example.com?x=y+z&a=1&b=2#section2
```
## Request types
All requests have type `RequestTemplate[U]`, where `U[_]` specifies if the request method and URL are specified. There
are two type aliases for the request template that are used:
* `type Request = RequestTemplate[Id]`, where `type Id[X] = X` is the identity, meaning that the request has both a
method and URI.
* `type PartialRequest = RequestTemplate[Empty]`, where `type Empty[X] = None`, meaning that the request has neither
a method nor an URI. Both of these fields will be set to `None` (the `Option` subtype).
## Notes
* the encoding for `String`s defaults to `utf-8`.
* unless explicitly specified, the `Content-Type` defaults to:
* `text/plain` for text
* `application/x-www-form-urlencoded` for form data
* `multipart/form-data` for multipart form data
* `application/octet-stream` for everything else (binary)
## Other Scala HTTP clients
* [scalaj](https://github.com/scalaj/scalaj-http)
* [akka-http client](http://doc.akka.io/docs/akka-http/current/scala/http/client-side/index.html)
* [dispatch](http://dispatch.databinder.net/Dispatch.html)
* [play ws](https://github.com/playframework/play-ws)
* [fs2-http](https://github.com/Spinoco/fs2-http)
* [http4s](http://http4s.org/v0.17/client/)
|
