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.TYPE})
023public @interface Api {
024
025    /**
026     * 文档标题
027     *
028     * @return
029     */
030    String value();
031
032    /**
033     * 文档描述
034     *
035     * @return
036     */
037    String notes() default "";
038
039    /**
040     * 生成的文件路径，不配置的情况下，默认为 Controller 的 mapping 转换，例如 mapping 为：/abc/aaa 转为为 abc_aaa。 / 转为为 index。
041     *
042     * @return
043     */
044    String filePath() default "";
045
046    /**
047     * 其他类的方法也汇总到此 API 文档里来
048     *
049     * @return
050     */
051    Class<?>[] collect() default {};
052
053    /**
054     * 生成文档的排序
055     *
056     * @return
057     */
058    int orderNo() default 0;
059
060}