io.quarkus.vertx.web.RouteBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-reactive-routes Show documentation

REST framework offering the route model to define non blocking endpoints

There is a newer version: 3.15.0

Show newest version

package io.quarkus.vertx.web;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation used to configure some defaults for reactive routes declared on a class.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface RouteBase {

    /**
     * The value is used as a prefix for any route method declared on the class where {@link Route#path()} is used.
     *
     * @return the path prefix
     */
    String path() default "";

    /**
     * The values are used for any route method declared on the class where {@link Route#produces()} is empty.
     *
     * @return the produced content types
     */
    String[] produces() default {};

    /**
     * The values are used for any route method declared on the class where {@link Route#consumes()} is empty.
     *
     * @return the consumed content types
     */
    String[] consumes() default {};

}