001/**
002 * Copyright (c) 2015-2022, Michael Yang 杨福海 (fuhai999@gmail.com).
003 * <p>
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * <p>
008 * http://www.apache.org/licenses/LICENSE-2.0
009 * <p>
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package io.jboot.apidoc.annotation;
017
018import java.lang.annotation.*;
019
020@Inherited
021@Retention(RetentionPolicy.RUNTIME)
022@Target({ElementType.METHOD, ElementType.PARAMETER})
023public @interface ApiResp {
024
025    /**
026     * 字段名称
027     *
028     * @return
029     */
030    String field();
031
032    /**
033     * 描述
034     *
035     * @return
036     */
037    String notes();
038
039    /**
040     * 数据类型
041     *
042     * @return
043     */
044    Class<?> dataType() default String.class;
045
046    /**
047     * 泛型类型
048     *
049     * @return
050     */
051    Class<?>[] genericTypes() default {};
052
053
054    /**
055     * mock 数据
056     *
057     * @return
058     */
059    String mock() default "";
060
061
062}