当前位置: 首页 > 工具软件 > JApiDocs > 使用案例 >

JApiDocs

马坚白
2023-12-01

git地址
可以基于 Controller 上的 Java 注释,直接生成接口文档

<dependency>
    <groupId>io.github.yedaxia</groupId>
    <artifactId>japidocs</artifactId>
    <version>1.4.4</version>
</dependency>
public class TestJApiDocs {
    public static void main(String[] args) {
        // 1. 创建生成文档的配置
        DocsConfig config = new DocsConfig();
        config.setProjectPath("/Users/japidocs"); // 项目所在目录
        config.setDocsPath("/Users/Downloads/"); // 生成 HTML 接口文档的目标目录
        config.setAutoGenerate(true); // 是否给所有 Controller 生成接口文档
        config.setProjectName("示例项目"); // 项目名
        config.setApiVersion("V1.0"); // API 版本号
        config.addPlugin(new MarkdownDocPlugin()); // 使用 MD 插件,额外生成 MD 格式的接口文档
        // 2. 执行生成 HTML 接口文档
        Docs.buildHtmlDocs(config);
    }
}

@ApiDoc

@Ignore

@description

 类似资料:

相关阅读

相关文章

相关问答