Module io.avaje.http.api

Package io.avaje.http.api

Annotation Type BeanParam

@Target({PARAMETER,METHOD})
@Retention(RUNTIME)
public @interface BeanParam

A parameter that is a bean containing query parameters, headers and cookies.

The properties on the bean are by default treated as query parameters.

This is functionally very similar to @Form but intended for use with all other cases than FORM POST.

Example

Simple bean parameter, properties default to query parameters matching the property name.

   public class MyParams {

     public String filter;

     @Default("name")
     public String orderBy;

     public int firstRow;
     public int maxRows

     @Header
     public String lastModified;
   }

   ...

   @Get("/search")
   List<Customer> findCustomers(@BeanParam MyParams params) {
     ...
   }