akka/akka-http

Add query parameter name to ParamsSpec

Open

#3.566 geöffnet am 23. Okt. 2020

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Scala (598 Forks)batch import
1 - triagedhelp wantednice-to-have (low-prio)t:routing

Repository-Metriken

Stars
 (1.311 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 1h 17m) (1 gemergte PR in 30 T)

Beschreibung

The trait ParamsSpec could also contain the following:

def name: String

being name the requested query parameter field name. This would be very useful for us because we want to override the parameter directive adding some extra action (adding an attribute to the HttpRequest to keep track of consumed query parameters):

  private val atKey: AttributeKey[Set[String]] = AttributeKey("allowed-query-params")

  private def trackQueryParam(name: String): Directive0 =
    optionalAttribute(atKey).flatMap { paramsOpt =>
      mapRequest(addAttribute(atKey, paramsOpt.fold(Set(name))(_ + name)))
    }

def param(pdef1: ParamSpec): Directive[Tuple1[pdef1.Out]] =
    Directives.parameter(pdef1.name) & trackQueryParam(pdef1.name)

Since the field name is not currently accessible from ParamSpec we have to do some ugly work around to make that work currently.

Contributor Guide