options
Matches requests with HTTP method OPTIONS
.
Signature
def options: Directive0
Description
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 MethodRejectionMethodRejection, which is translated into a 405 Method Not Allowed
response by the default RejectionHandler.
Example
- Scala
-
val route = options { complete("This is an OPTIONS request.") }
// tests:
Options("/") ~> route ~> check {
responseAs[String] shouldEqual "This is an OPTIONS request."
}
- Java
-
final Route route = options(() -> complete("This is a OPTIONS request."));
testRoute(route).run(HttpRequest.OPTIONS("/")).assertEntity(
"This is a OPTIONS request.");