io.quarkus.vertx.web

Annotation Type Route

@Repeatable(value=Route.Routes.class)
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Route

Annotation used to configure reactive routes in a declarative way.

The target business method must return void and accept exactly one argument. must return void and accept exactly one argument. The type of the argument can be RoutingContext, io.vertx.reactivex.ext.web.RoutingContext or RoutingExchange.

If both path() and regex() are set the regular expression is used for matching.

If neither path() nor regex() is set the route will match a path derived from the name of the method. This is done by de-camel-casing the name and then joining the segments with hyphens.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	consumes Used for content-based routing.
io.vertx.core.http.HttpMethod[]	methods
int	order If set to a positive number, it indicates the place of the route in the chain.
String	path
String[]	produces Used for content-based routing.
String	regex
Route.HandlerType	type

Element Detail

path

public abstract String path

Returns:

the path

See Also:

Router.route(String)

Default:

""

regex

public abstract String regex

Returns:

the path regex

See Also:

Router.routeWithRegex(String)

Default:

""

methods

public abstract io.vertx.core.http.HttpMethod[] methods

Returns:

the HTTP methods

See Also:

Route.methods()

Default:

{}

type

public abstract Route.HandlerType type

Returns:

the type of the handler

Default:

io.quarkus.vertx.web.Route.HandlerType.NORMAL

order

public abstract int order

If set to a positive number, it indicates the place of the route in the chain.

See Also:

io.vertx.ext.web.Route#order()

Default:

0

produces

public abstract String[] produces

Used for content-based routing.

Returns:

the produced content types

See Also:

Route.produces(String)

Default:

{}

consumes

public abstract String[] consumes

Used for content-based routing.

Returns:

the consumed content types

See Also:

Route.consumes(String)

Default:

{}