io.quarkus.resteasy.reactive.links.InjectRestLinks Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-rest-links Show documentation

Web Links support for Quarkus REST. Inject web links into response HTTP headers by annotating your endpoint resources.

The newest version!

package io.quarkus.resteasy.reactive.links;

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

/**
 * Inject web links into the response HTTP headers with the "Link" header field.
 * Only the response of the REST methods annotated with {@link RestLink} will include the "Link" headers.
 * 
 * The InjectRestLinks annotation can be used at either class or method levels.
 * 
 *
 * @see RFC 5988 Web Linking Standard
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
public @interface InjectRestLinks {

    /**
     * Find all the types available in {@link RestLinkType}.
     *
     * @return what types of links will be injected.
     */
    RestLinkType value() default RestLinkType.TYPE;
}