pekko/akka-docs-dev/rst/scala/http/routing-dsl/directives/respond-with-directives/respondWithHeader.rst

.. _-respondWithHeader-:

respondWithHeader
=================

Signature
---------

.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/RespondWithDirectives.scala
   :snippet: respondWithHeader


Description
-----------
Adds a given HTTP header to all responses coming back from its inner route.

This directive transforms ``HttpResponse`` and ``ChunkedResponseStart`` messages coming back from its inner route by
adding the given ``HttpHeader`` instance to the headers list.

See also :ref:`-respondWithHeaders-` if you'd like to add more than one header.

Example
-------

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

			`respondWithHeader`
			`=================`

			`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/RespondWithDirectives.scala`
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00			`:snippet: respondWithHeader`


			`Description`
			`-----------`
=htc,doc #18496 make all directive docs have the same style, some additions 2015-10-09 15:19:36 +02:00			`Adds a given HTTP header to all responses coming back from its inner route.`
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00
			This directive transforms ``HttpResponse`` and ``ChunkedResponseStart`` messages coming back from its inner route by
			adding the given ``HttpHeader`` instance to the headers list.

=htc,doc #18496 make all directive docs have the same style, some additions 2015-10-09 15:19:36 +02:00			See also :ref:`-respondWithHeaders-` if you'd like to add more than one header.
=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/RespondWithDirectivesExamplesSpec.scala`
+htp #18496 add missing directive documentation (scala) 2015-10-01 13:25:41 +02:00			`:snippet: respondWithHeader-0`