apidoc-javadoc-generator

apidoc-javadoc-generator

一、项目介绍

apidoc是用node.js开发的可以根据api的注释文档生成相应的RESTful风格的api文档的工具，而且支持多种开发api的语言。 使用apidoc时生成文档时需要 3 步（默认使用者已经安装了node.js、apidoc，如果没有可以根据这个来完成：node.js，v6版本的node.js安装后会把npm也装好， apidoc install ）

1. 完成api的注释文档；

2. 完成apidoc.json（这一步可省略）；

3. 使用命令apidoc -i doc_dir -o output_dir run，在哪个目录下执行这个命令，apidoc.json放在哪个目录就行，就可生成漂亮美观的api文档了。

　　这个项目就是实现的就是可以根据java的注解和maven插件配置来生成apidoc注释的maven插件，即完成上面的第一步，也是最烦人的一步， 而且只支持使用spring mvc框架来开发的api。

二、使用介绍

1、把项目down下来，然后maven install到本地maven仓库（也可deploy到maven私服，供他人使用）

D:\apidoc-javadoc-generator>mvn install -Dmaven.test.skip=true

2、在自己的项目中引入依赖和插件

<dependency>
    <groupId>com.cmy</groupId>
    <artifactId>apidoc-javadoc-generator-core</artifactId>
    <version>0.0.1</version>
</dependency>

<build>
<plugins>
    <plugin>
        <groupId>com.cmy</groupId>
        <artifactId>apidoc-javadoc-generator-maven-plugin</artifactId>
        <version>0.0.1</version>
        <dependencies>
            <!-- 插件依赖于spring mvc，如果自己项目里引入了别的依赖也可以在这里添加 -->
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-web</artifactId>
                <version>${spring.version}</version>
            </dependency>

            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>${spring.version}</version>
            </dependency>
        </dependencies>
        <configuration>
            <apiDocFileName>ApiDocContent</apiDocFileName>
            <apiDocDir>src\test\java</apiDocDir>
            <apiSources>
                <apiSource>com.cmy.controller.XxController</apiSource>
            </apiSources>
        </configuration>
    </plugin>
</plugins>
</build>