pekko/akka-docs/rst/scala/http/routing-dsl/directives/method-directives/options.rst
2016-01-14 00:31:03 +01:00

25 lines
724 B
ReStructuredText

.. _-options-:
options
=======
Signature
---------
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
:snippet: options
Description
-----------
Matches requests with HTTP method ``OPTIONS``.
This directive filters the incoming request by its HTTP method. Only requests with
method ``OPTIONS`` are passed on to the inner route. All others are rejected with a
``MethodRejection``, which is translated into a ``405 Method Not Allowed`` response
by the default :ref:`RejectionHandler <The RejectionHandler>`.
Example
-------
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/MethodDirectivesExamplesSpec.scala
:snippet: options-method