pekko/akka-docs/rst/scala/http/routing-dsl/directives/parameter-directives/parameter.rst

.. _-parameter-:

parameter
=========

Signature
---------

.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/ParameterDirectives.scala
   :snippet: parameter

Description
-----------
Extracts a *query* parameter value from the request.

See :ref:`-parameters-` for a detailed description of this directive.

See :ref:`which-parameter-directive` to understand when to use which directive.

Example
-------

.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
   :snippet: example-1
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00			`.. _-parameter-:`

			`parameter`
			`=========`

			`Signature`
			`---------`

=doc fix broken links in scala-side HTTP docs 2015-06-19 15:35:24 +02:00			`.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/ParameterDirectives.scala`
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00			`:snippet: parameter`

			`Description`
			`-----------`
=htc,doc #18496 make all directive docs have the same style, some additions 2015-10-09 15:19:36 +02:00			`Extracts a query parameter value from the request.`
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00
+doc,htp #18496 improved parameter docs a bit 2015-10-08 16:26:29 +02:00			See :ref:`-parameters-` for a detailed description of this directive.

			See :ref:`which-parameter-directive` to understand when to use which directive.
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00
			`Example`
			`-------`

=doc #18104 fixes typo which made includecode2 not work in many places Note that some of the files don't exist, fixing this very soon. 2015-09-16 23:50:35 +02:00			`.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala`
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00			`:snippet: example-1`