ParameterDirectives • Akka HTTP (original) (raw)
- When to use which parameter directive?
- parameter
- parameters
- parameterMap
- parameterMultiMap
- parameterSeqparameterList
When to use which parameter directive?
Usually, you want to use the high-level parameters directive. When you need more low-level access you can use the table below to decide which directive to use which shows properties of different parameter directives.
| directive | level | ordering | multi |
|---|---|---|---|
| parameter | high | no | no |
| parameters | high | no | yes |
| parameterMap | low | no | no |
| parameterMultiMap | low | no | yes |
| parameterSeqparameterList | low | yes | yes |
level
high-level parameter directives extract subset of all parameters by name and allow conversions and automatically report errors if expectations are not met, low-level directives give you all parameters at once, leaving all further processing to you
ordering
original ordering from request URL is preserved
multi
multiple values per parameter name are possible
Note
If you need to extract multiple parameters, apply the parameter directive multiple times.
Found an error in this documentation? The source code for this page can be found here. Please feel free to edit and contribute a pull request.