ru.tinkoff.kora.http.common.annotation.Path Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of http-common Show documentation

Kora http-common module

The newest version!

package ru.tinkoff.kora.http.common.annotation;

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

/**
 * Русский: Аннотация указывает аргумент метода должен быть интерпретирован как часть пути запроса/ответа
 * 
 * English: Annotation specifies the method argument should be interpreted as a part of request/response path
 * 

 * 

 * Пример / Example:
 *  * {@code
 * @HttpClient("my.config")
 * public interface MyHttpClient {
 *
 *     @HttpRoute(method = "GET", path = "/username/{name}")
 *     String getUserCode(@Path("name") String value);
 * }
 * }
 * 
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER})
public @interface Path {

    /**
     * @return Русский: Описывает имя параметра пути
     * 
     * English: Describes the name of the Path parameter
     */
    String value() default "";
}