42 lines
No EOL
1.5 KiB
ReStructuredText
42 lines
No EOL
1.5 KiB
ReStructuredText
.. _-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
|
|
-------
|
|
|
|
The ``respondWithDefaultHeaders`` directive is equivalent to the ``respondWithDefaultHeader`` directive which
|
|
is shown in the example below, however it allows including multiple default headers at once in the directive, like so::
|
|
|
|
respondWithDefaultHeaders(
|
|
Origin(HttpOrigin("http://akka.io"),
|
|
RawHeader("X-Fish-Name", "Blippy"))) { /*...*/ }
|
|
|
|
|
|
The semantics remain the same however, as explained by the following example:
|
|
|
|
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/RespondWithDirectivesExamplesSpec.scala
|
|
:snippet: respondWithDefaultHeader-0
|
|
|
|
See the :ref:`-respondWithDefaultHeader-` directive for an example with only one header. |