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

28 lines
796 B
ReStructuredText
Raw Normal View History

.. _-respondWithHeader-:
respondWithHeader
=================
Adds a given HTTP header to all responses coming back from its inner route.
Signature
---------
.. includecode2:: /../../akka-http-scala/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