com.github.liuanxin.api.annotation.ApiMethod Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-document Show documentation

Collect api document, support to spring mvc

There is a newer version: 0.9.8

package com.github.liuanxin.api.annotation;

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ApiMethod {

    /** @return method title */
    String value();

    /** @return api developer */
    String develop() default "";

    /** @return api description */
    String desc() default "";

    /** @return more forward when smaller */
    int index() default Integer.MAX_VALUE;

    /**
     * not set will use global config(default true).
     *
     * true  : output in the return example.
     * false : listed separately.
     * @return return whether the example contains comment
     */
    boolean[] commentInReturnExample() default {};

    /**
     * true  : the hierarchical relationship corresponding to the field will be used to process the comment, Generics be sure to use determined types.
     * false : will use index corresponding to the field to process the comment, when use @JsonPropertyOrder to change field sort, there will be problems.
     * @return return whether the comment is displayed in a hierarchy
     */
    boolean commentInReturnExampleWithLevel() default true;

    /**
     * Return Field Description Whether to record the parent attribute when listed separately,
     * regardless of this value when commentInReturnExample is true.
     *
     * forget this. It's a bad ide
     * @return comment print record level
     */
    boolean[] returnRecordLevel() default {};

    /**
     * customize return type, if set will ignore 「the return type」 on method
     * @return customize return type
     */
    ApiReturnType[] returnType() default {};
}