akka/akka-http

DOCS: make sure to document needed implicits

Open

#278 opened on Sep 12, 2016

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

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

Description

Issue by rkuhn Friday Jul 17, 2015 at 07:13 GMT Originally opened as https://github.com/akka/akka/issues/18021

From the mailing list:

I got hit by this stuff today when moving some tests from one package to another disabled responseAs[String] completely (earlier, it worked in some endpoints, but not in others). The answer is to import akka.http.scaladsl.unmarshalling.Unmarshaller._ in tests, which mixes in PredefinedFromEntityUnmarshallers, which contain an unmarshaller to string. Second, it is necessary to import akka.http.scaladsl.marshalling.Marshaller._ in the file where the route is defined, so that string responses are marshalled correctly (if you don't do it, your response bodies unmarshalled in tests will contain an extra set of double quotes).

Contributor guide

Research direction
Add documentation explaining the necessary imports for implicit marshallers and unmarshallers in Akka HTTP.
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.
Stale
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.
80