akka/akka-http

Allow matching multiple query parameters in Java API

Open

#605 opened on Dec 1, 2016

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Scala (1,311 stars) (598 forks)batch import
1 - triageddiscusshelp wantedt:java

Description

Currently, if there is a call with multiple query parameters, there are two ways to code it:

Nesting parameter directives:

parameter("param1_name",  param1 ->
    parameter("param2_name", param2 -> method(param1, param2))

, which quickly gets of hand in terms of size and readability, or using parameterMap/parameterList and checking for their availability manually. One has an unfeasible amount of ceremony, and the other results in error-prone code. Some more concise API needs to be added.

Contributor guide

Tech stack
scalajava
Domain
apideveloper experience
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.
1-2 days
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.
mostly clear
Prerequisites
Familiarity with akka http Java APIUnderstanding of query parameter handlingScala/Java development environment
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the existing Java API for query parameter handling, particularly the 'parameter' directive and 'parameterMap'/'parameterList' methods in the akka http Java DSL source (likely in akka http/src/main/java/akka/http/javadsl/server/directives/). Look at the Scala implementation for a type safe multi parameter extraction. Propose a new overload that accepts multiple parameter names and a lambda with multiple arguments, possibly using a tuple or a custom builder pattern. Discuss the design with maintainers via issue comments before implementing.