patch

Matches requests with HTTP method PATCH.

Signature

def patch: Directive0

Description

This directive filters the incoming request by its HTTP method. Only requests with method PATCH 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 = patch { complete("This is a PATCH request.") }

// tests:
Patch("/", "patch content") ~> route ~> check {
  responseAs[String] shouldEqual "This is a PATCH request."
}
Java
import static akka.http.javadsl.server.Directives.complete;
import static akka.http.javadsl.server.Directives.patch;

final Route route = patch(() -> complete("This is a PATCH request."));

testRoute(route).run(HttpRequest.PATCH("/").withEntity("patch content"))
    .assertEntity("This is a PATCH request.");
Found an error in this documentation? The source code for this page can be found here. Please feel free to edit and contribute a pull request.