#  iartisan-generator-apiDoc

**Repository Path**: wunderfly/iartisan-generator-apiDoc

## Basic Information

- **Project Name**:  iartisan-generator-apiDoc
- **Description**: apiDoc maven 生成插件，插件的作用也只是让你用的时候感觉会爽一点点（大概几个字母），目前只支持windows
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2017-10-21
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![输入图片说明](https://git.oschina.net/uploads/images/2017/1010/122328_10a89e8f_639234.png "iartisan.png")
#  iartisan-generator-apiDoc
apiDoc maven 生成插件

代码很少，依赖[apidoc](http://http://apidocjs.com/)包装了一个maven插件，你可以完全使用[apidoc](http://http://apidocjs.com/)！

插件的作用也只是让你用的时候感觉会爽一点点（大概几个字母），目前只支持windows

 **前置工作** 
- 安装node.js 参考官网：https://nodejs.org
- 安装apidoc  参考官网：http://apidocjs.com/

 **使用** 

pom.xml 文件中添加plugin

```
           <plugin>
                <groupId>org.iartisan</groupId>
                <artifactId>iartisan-generator-apiDoc</artifactId>
                <version>1.0</version>
                <configuration>
                    <apiDocConfig>
                        <output>apiDoc</output>
                    </apiDocConfig>
                </configuration>
            </plugin>
```
 **运行** 
```
mvn apiDoc:go
```
 **运行结果** 
![输入图片说明](https://git.oschina.net/uploads/images/2017/1010/123209_26101a5f_639234.png "TIM图片20171010123400.png")
具体参考：http://apidocjs.com/example_basic/