options

Signature

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 RejectionHandler.

Example

val route = options { complete("This is an OPTIONS request.") }

// tests:
Options("/") ~> route ~> check {
  responseAs[String] shouldEqual "This is an OPTIONS request."
}