freshwood / akka-http-rest-client

A simple and ready to use akka http client for building HTTP requests and processing responses with custom response handlers

akka-http-rest-client

A simple and ready to use akka http client for building HTTP requests and processing responses with custom response handlers

akka-http-rest-client is based on the Akka HTTP architecture. The goal is to have an easy to use REST client, which can be used in almost any Scala project

Features

• Easy using like Spring Rest Templates
• Builder style for a simple request building
• Almost all http methods available
• Default response processor support
• Functionality to un marshall responses with a given un marshaller (less code for you)
• Development was focused on JSON support
• Compression support for deflate / gzip responses

Documentation

https://freshwood.github.io/akka-http-rest-client/

Installation

// All releases are published to bintray
resolvers += Resolver.bintrayRepo("freshwood", "maven")

libraryDependencies ++= List(
  "net.softler" %% "akka-http-rest-client" % "0.2.1"
)

(ammonite)

interp.repositories() ++= Seq(coursier.MavenRepository("https://dl.bintray.com/freshwood/maven/"))

import $ivy.`net.softler::akka-http-rest-client:0.2.1`

Usage

Simple as hell

// When you have an unmarshaller available: (e.g: RootJsonFormat[User])
val result: Future[User] = ClientRequest("http://test.de/1").withJson.get[User]

// Or you just maka a call...
val result: Future[ClientResponse] = testRequest.get()

// Now you can process the response with the inline processor
// The future will fail when an error occurs
val processed: Future[ResponseEntity] = result map(_.process)

// Or you just handle the response by your own
val original: Future[HttpResponse] = result.map(_.response)

Handle (Gzip, Deflate) responses

// Just a request on a API with GZIP responses
val result: Future[ClientResponse] = encodedRequest.withText.get()

// Just map over the entire response an encoder to get your desired object 
val string = result.map(_.decode).flatMap(_.as[String])

Contribution

It would be a pleasure to see a nice contribution. Just add a PR (Pull Request) Or you add an issue with an corresponding PR.

License

This code is open source software licensed under the MIT License

akka-http-rest-client's Issues

Update Scala version (2.12.4)

Update to the latest scala version

• Version 2.12.4

Compatibility with akka-http 10.1.x

Make sure we have compatibility to the latest akka relases

Extend documentation

Extend the documentation and more helpful samples.
The docu should contain the following section

• Definition
• Installation
• Usage
• Http Methods
• When to use?

Update to the latest Scala version

Update to the latest Scala version

The new Scala version 2.12.5 is out.

https://github.com/scala/scala/releases/tag/v2.12.5

tcp idle-timeout

I encounter an error, sth like "tcp idle-timeout, no bytes pass in last 1 minutes"
I'd like to change it to 3 minutes.
How do I do it using the library?

Or just set the below property in configuration file?
akka.http.client.idle-timeout

Thanks!

how to post?

Hi, assume I want to post some data to a rest api

val respEntity: Future[ByteString] = for {
request <- Marshal(postData.getBytes()).to[RequestEntity]
response <- ClientRequest().withJson.uri(uri).post().map(_.response)
entity <- Unmarshal(response.entity).to[ByteString]
} yield entity

where should I put request in post?

thanks.

Update to the latest sbt version (1.1.1)

Update to the latest sbt version

• sbt version 1.1.1

Update to the latest akka version

Update to the latest akka version

• Update to the latest version to have all features and fixes from the akka team available

Add logging support

Make sure we are make some logging.
e.g.

• Requests
• Response Errors