# apidoc-generator

**Repository Path**: whan0216/apidoc-generator

## Basic Information

- **Project Name**: apidoc-generator
- **Description**: No description available
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-23
- **Last Updated**: 2021-10-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# apidoc-generator

#### 介绍
apidoc-generator是针对Java开发者提供的提效工具，在团队协作开发过程中，撰写接口文档经常会占用太多时间，效率底下，这个工具可以帮助大家快速生成美观且可读性高的接口文档


#### 软件架构
该项目是一个maven插件


#### 安装教程

在项目的api模块下的pom文件中配置maven插件即可。如下：

```
<build>
    <plugins>
        <plugin>
            <groupId>online.shuita.gitee</groupId>
            <artifactId>apidoc-generator</artifactId>
            <version>1.0.0-SNAPSHOT</version>
            <configuration>
                <targetClass>com.ymm.scheduler.sac.facade.shipper.TicketFacade</targetClass>
                <generatorExtParams>
                    <outPath>D:\\共享目录</outPath>
                </generatorExtParams>
            </configuration>
        </plugin>
    </plugins>
</build>
```
 **targetClass：** 需要生成接口文档的接口类
 **generatorExtParams.outPath：** 生成的接口文档输出的路径，可以是具体的文件，也可以是一个目录


#### 使用说明

执行具体的mvn插件即可：

```
mvn apidoc-generator:generate
```

idea执行：
![输入图片说明](https://images.gitee.com/uploads/images/2021/0819/201317_4d0e331f_381300.png "054BFAAF-B2A5-4c93-8732-298B4BA39175.png")


执行结果：
![输入图片说明](https://images.gitee.com/uploads/images/2021/0819/201708_dc33b032_381300.png "A067D2D8-D509-4699-ADFC-E59DA0D130AF.png")


#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  支持泛型的解析
2.  支持扩展自己的文档样式
3.  可自动识别代码中的注释做为字段说明