com.iiifi.kite.boot.annotation.VersionMapping Maven / Gradle / Ivy

Go to download
package com.iiifi.kite.boot.annotation;

import java.lang.annotation.*;
import org.springframework.core.annotation.AliasFor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @author [email protected] 花朝
 * @date 2018/8/18 12:59
 * @desc
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestMapping
@ApiVersion
@Validated
public @interface VersionMapping {

    /**
     * Alias for {@link RequestMapping#name}.
     * @return {String[]}
     */
    @AliasFor(annotation = RequestMapping.class)
    String name() default "";

    /**
     * Alias for {@link RequestMapping#value}.
     * @return {String[]}
     */
    @AliasFor(annotation = RequestMapping.class)
    String[] value() default {};

    /**
     * Alias for {@link RequestMapping#path}.
     * @return {String[]}
     */
    @AliasFor(annotation = RequestMapping.class)
    String[] path() default {};

    /**
     * Alias for {@link RequestMapping#params}.
     * @return {String[]}
     */
    @AliasFor(annotation = RequestMapping.class)
    String[] params() default {};

    /**
     * Alias for {@link RequestMapping#headers}.
     * @return {String[]}
     */
    @AliasFor(annotation = RequestMapping.class)
    String[] headers() default {};

    /**
     * Alias for {@link RequestMapping#consumes}.
     * @return {String[]}
     */
    @AliasFor(annotation = RequestMapping.class)
    String[] consumes() default {};

    /**
     * Alias for {@link RequestMapping#produces}.
     * @return {String[]}
     */
    @AliasFor(annotation = RequestMapping.class)
    String[] produces() default {};

    /**
     * Alias for {@link ApiVersion#value}.
     * @return {String}
     */
    @AliasFor(annotation = ApiVersion.class, attribute = "value")
    String version() default "";

    /**
     * Alias for {@link ApiVersion#useAppName}.
     * @return {boolean}
     */
    @AliasFor(annotation = ApiVersion.class, attribute = "useAppName")
    boolean useAppName() default true;
}