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

29 lines
988 B
ReStructuredText
Raw Normal View History

.. _-respondWithDefaultHeaders-:
respondWithDefaultHeaders
=========================
Adds the given HTTP headers to all responses coming back from its inner route only if a respective header with the same
name doesn't exist yet in the response.
Signature
---------
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/RespondWithDirectives.scala
:snippet: respondWithDefaultHeaders
Description
-----------
This directive transforms ``HttpResponse`` and ``ChunkedResponseStart`` messages coming back from its inner route by
potentially adding the given ``HttpHeader`` instances to the headers list.
A header is only added if there is no header instance with the same name (case insensitively) already present in the
response. If you'd like to add only a single header you can use the :ref:`-respondWithDefaultHeader-` directive instead.
Example
-------
See the :ref:`-respondWithDefaultHeader-` directive for an example with only one header.