pekko/akka-docs-dev/rst/scala/http/routing-dsl/directives/respond-with-directives/respondWithHeader.rst
Konrad Malawski 87f4447b23 =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

28 lines
No EOL
789 B
ReStructuredText

.. _-respondWithHeader-:
respondWithHeader
=================
Adds a given HTTP header to all responses coming back from its inner route.
Signature
---------
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/RespondWithDirectives.scala
:snippet: respondWithHeader
Description
-----------
This directive transforms ``HttpResponse`` and ``ChunkedResponseStart`` messages coming back from its inner route by
adding the given ``HttpHeader`` instance to the headers list.
If you'd like to add more than one header you can use the :ref:`-respondWithHeaders-` directive instead.
Example
-------
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/RespondWithDirectivesExamplesSpec.scala
:snippet: respondWithHeader-examples