akka/akka-http

Ability to use custom MediaTypes with `SprayJsonSupport`

Open

#316 opened on Sep 15, 2016

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Scala (598 forks)batch import
1 - triagedhackathonhelp wantedt:marshalling

Repository metrics

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

Description

The akka-http / Spray json integration is pretty good, but forces one to get generic application/json output. Use of more specific data types (e.g. application/problem+json) is common, and beneficial. However, I did not find a way to implement that with akka-http 2.4.10.

Suggestion: SprayJsonSupport could take an implicit MediaType parameter, defaulting to application/json.

I will make a local copy of the code and experiment with this approach. Decided to first bring this up as an Issue for discussion - can provide a PR if there's acceptance for such a feature.

https://github.com/akka/akka/blob/0ed4a2aae9ecab43ef806025596a5573ddc883ea/akka-http-marshallers-scala/akka-http-spray-json/src/main/scala/akka/http/scaladsl/marshallers/sprayjson/SprayJsonSupport.scala

Contributor guide

Research direction
Investigate the current implementation of SprayJsonSupport in the akka http source code. Understand how implicit marshallers/unmarshallers are defined. Then implement a solution that adds an implicit MediaType parameter defaulting to `application/json`, ensuring backward compatibility. Update the tests accordingly.
Tech stack
scala
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaAkka HTTP basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70