formField

Description

Allows extracting a single Form field sent in the request. Data posted from HTML Forms is either of type application/x-www-form-urlencoded or of type multipart/form-data.

Example

final Route route = route(
  formField("color", color ->
    complete("The color is '" + color + "'")
  ),
  formField(StringUnmarshallers.INTEGER, "id", id ->
    complete("The id is '" + id + "'")
  )
);

// tests:
final FormData formData = FormData.create(Pair.create("color", "blue"));
testRoute(route).run(HttpRequest.POST("/").withEntity(formData.toEntity()))
  .assertEntity("The color is 'blue'");

testRoute(route).run(HttpRequest.GET("/"))
  .assertStatusCode(StatusCodes.BAD_REQUEST)
  .assertEntity("Request is missing required form field 'color'");