akka/akka-http

Add a marshalling example to "HttpRequest and HttpResponse / Processing responses" documentation

Open

#2,842 opened on Dec 1, 2019

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Scala (598 forks)batch import
1 - triagedhackathonhelp wantedt:clientt:docst:marshalling

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 30d)

Description

In the documentation page on creating HTTP requests with akka-http client functionality, it would be extremely valuable if there was an example on how to include a marshalable object as a request entity. E.g.

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

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

for {
  entity <- Marshal[Pet("Mamon").to[RequestEntity]
  request <- HttpRequest(
    method = HttpMethods.POST,
    uri = "https://userservice.example/users",
    entity = entity
  )
} yield request

I have not made a pull request for this as I wouldn't be able to provide a Java version anyway.

There is a documentation page about using marshallers, but it would be very handy to have those two pieces of information presented together.

Contributor guide

Research direction
Add a marshalling example to the 'Processing responses' section of the Akka HTTP documentation, following the existing pattern for Scala and Java.
Tech stack
scala
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaAkka HTTP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90