«Bean Param»

Stereotype «BeanParam» is used to mark a class or parameter as so called bean parameter. Bean parameters can be used to group REST parameters together.

This has mainly two benefits:

• Instead of defining the same set of parameters for every REST operation over and over again you can just use the bean parameter instead. This is a great help to keep the parameters of your REST services consistent among all operations.

• When it comes to code generation for Java service interfaces the bean parameter class is used as parameter of the operation instead of the individual parameters. This helps to have clearer interfaces and also ensure a better maintainability

Stereotype «BeanParam» on classes makes only sense when at least one of the attributes of the class is marked as REST parameter (stereotypes «PathParam», «HeaderParam», «QueryParam», «CookieParam»)

Open

For further information please refer to:

• «REST Resource»

• «REST Operation»

• How to model REST Services

• Generating Code for REST Services