akka/akka-http

no examples of FromRequestUnmarshaller in docs or codebase

Open

#1,325 opened on Aug 4, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedsmallt:docst:http:marshalling

Repository metrics

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

Description

Issue by kornelc Saturday Jul 16, 2016 at 22:56 GMT Originally opened as https://github.com/akka/akka/issues/20972

I'm trying to extract a case class with json4s from the entity (form submission) and realized that there are no examples anywhere on how to create these unmarshallers. The doc just has 'implicit val orderUM: FromRequestUnmarshaller[Order] = ???' as an example which doesn't help much unless somebody is already familiar with unmarshallers, which I am not at this point. It would be great to include a case class unmarshalling example in the docs.

Contributor guide

Research direction
Study existing FromRequestUnmarshaller implementations in Akka HTTP codebase or documentation, and create a simple case class unmarshalling example using json4s.
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
Scala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60