com.duoec.doc.DuoDocletConfig Maven / Gradle / Ivy

Go to download
package com.duoec.doc;

import java.io.File;

/**
 * Duo-Doc配置
 *
 * @author xuwenzhen
 */
public class DuoDocletConfig {
    private DuoDocletConfig() {
    }

    /**
     * 即当前插件所在的项目路径，不一定是项目的根目录
     * 推荐将插件会配置在启动项目里面
     */
    public static String baseDir;

    /**
     * baseDir的File对象
     */
    public static File baseDirFile;

    /**
     * appId
     */
    public static String appId;

    /**
     * 生成的文档导出到哪里，可选：mongodb | console | json
     */
    public static String exporter = "json|server";

    /**
     * 当export=json时，导出文件的名称，默认为：api.json
     * 如果为绝对路径，则导出到指定的路径，否则导出到项目根目录下
     */
    public static String jsonExporterFileName = "api.json";

    /**
     * 当export=javaSerialize时，导出文件的名称，默认为：api.serial.data
     * 如果为绝对路径，则导出到指定的路径，否则导出到项目根目录下
     */
    public static String javaSerializeFileName = "api.serial.data";

    /**
     * 导出json文件，是否排除掉markdown内容，默认true=排除掉
     */
    public static boolean jsonExporterExcludeMarkdown = true;

    /**
     * 输出目录，如果exporter为输出文件时，会用到此配置
     */
    public static String outputDirectory = "target";

    /**
     * 文档服务地址，https://doc.duoec.com
     */
    public static String server = "http://127.0.0.1:17010";

    /**
     * 文档推送到服务器时需要的key
     */
    public static String docPushKey = null;

    /**
     * README.md文件地址，如果不指定，默认为 ${baseDir}/README.md
     * 可以指定为：../README.md
     * 如果文档需要使用别的名称，也可以指定，比如：index.md
     */
    public static String readme = "README.md";

    /**
     * markdown文件目录，如果不指定，默认为 ${baseDir}/doc
     */
    public static String markdownDir;

    /**
     * chapter 名称
     */
    public static String tagChapter = "@chapter";

    /**
     * section 名称
     */
    public static String tagSection = "@section";

    /**
     * api 名称
     */
    public static String tagApi = "@api";


    /**
     * chapter排序
     */
    public static String tagChapterSort = "@c1";

    /**
     * chapter默认排序值
     */
    public static Integer defaultChapterSort = 100;

    /**
     * section排序
     */
    public static String tagSectionSort = "@c2";

    /**
     * section默认排序值
     */
    public static Integer defaultSectionSort = 100;

    /**
     * api排序
     */
    public static String tagApiSort = "@c";

    /**
     * api默认排序值
     */
    public static Integer defaultApiSort = 100;

    /**
     * api key，如果自行指定，请确保全局唯一，否则会出现覆盖的情况
     * 未指定时，会自动生成：MD5({接口类型}_{接口签名})
     */
    public static String tagApiKey = "@key";

    /**
     * 自XXX起，支持多个可以使用逗号分隔
     */
    public static String tagSince = "@since";

    /**
     * 作者，支持多个可以使用分号分隔
     */
    public static String tagAuthor = "@author;@auth";

    /**
     * 废弃，支持多个可以使用分号分隔
     */
    public static String tagDeprecated = "@deprecated";

    /**
     * 返回
     */
    public static String tagReturn = "@return";

    /**
     * 禁止，支持多个可以使用分号分隔
     */
    public static String tagDisable = "@disable";

    /**
     * 必填，支持多个可以使用分号分隔
     */
    public static String tagRequired = "@required";

    /**
     * Demo值，支持多个可以使用分号分隔
     */
    public static String tagDemo = "@demo";

    /**
     * 接口链接，支持多个可以使用分号分隔
     */
    public static String tagLink = "@link";

    /**
     * 接口是否不可Mock，有此标识的即为不可Mock
     */
    public static String tagNoMock = "@no-mock";

    /**
     * 接口是否不可调用，有此标识的即为不可调用
     */
    public static String tagNoInvoke = "@no-invoke";

    /**
     * 默认的book name
     */
    public static String defaultChapterName = "服务接口";
}