xDoc 项目教程

xDoc 项目教程

1. 项目目录结构及介绍

xDoc 项目的目录结构如下：

xDoc/
├── doc/
│   └── ...
├── samples/
│   ├── samples/
│   └── spring-boot-starter-xDoc/
├── xDoc-core/
├── xDoc-jfinal/
├── xDoc-spring/
├── xDoc-view/
├── .gitignore
├── 1.0版本目标.md
├── LICENSE
├── README.md
└── pom.xml

目录介绍

• doc/: 存放项目文档的目录。
• samples/: 包含示例代码，特别是 spring-boot-starter-xDoc 目录，展示了如何在 Spring Boot 项目中使用 xDoc。
• xDoc-core/: xDoc 的核心模块，包含生成接口文档的核心逻辑。
• xDoc-jfinal/: 针对 JFinal 框架的扩展模块。
• xDoc-spring/: 针对 Spring 框架的扩展模块。
• xDoc-view/: 视图模块，用于生成文档的视图部分。
• .gitignore: Git 忽略文件配置。
• 1.0版本目标.md: 项目版本目标文档。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• pom.xml: Maven 项目配置文件。

2. 项目启动文件介绍

xDoc 项目的主要启动文件是 TestApplication.java，位于 samples/sample-springboot/src/main/java/com/github/treeleafj/xdoc/samples/springboot/TestApplication.java。

TestApplication.java

@EnableXDoc //<--- 加上此注解以便启用XDOC在线HTML文档
@SpringBootApplication
public class TestApplication {
    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }
}

启动步骤

1. 在 TestApplication 类上添加 @EnableXDoc 注解，以启用 xDoc 的在线 HTML 文档生成功能。
2. 运行 main 方法启动 Spring Boot 应用。

3. 项目的配置文件介绍

xDoc 的配置文件主要位于 application.properties，位于 samples/sample-springboot/src/main/resources/application.properties。

application.properties

xdoc.enable=true #是否启动XDoc，默认是true，生产环境建议改为false
xdoc.sourcePath=F:/java/project/xDoc/samples/sample-springboot/src/main/java #源码路径，多个路径时用英文逗号隔开
xdoc.title=用户中心接口文档 #用于配置文档页面标题
xdoc.version=1.0 #标识接口文档的版本号

配置项说明

• xdoc.enable: 是否启用 xDoc 功能，默认是 true，生产环境建议改为 false。
• xdoc.sourcePath: 项目源码的路径，多个路径时用英文逗号隔开。
• xdoc.title: 生成的接口文档页面的标题。
• xdoc.version: 接口文档的版本号。

通过以上配置，可以灵活控制 xDoc 的启动和文档生成行为。