apidoc-javadoc-generatorRESTful 風格 API 文檔生成工具

apidoc-javadoc-generator

一、項目介紹

apidoc是用node.js開發(fā)的可以根據api的注釋文檔生成相應的RESTful風格的api文檔的工具，而且支持多種開發(fā)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，在哪個目錄下執(zhí)行這個命令，apidoc.json放在哪個目錄就行，就可生成漂亮美觀的api文檔了。

　　這個項目就是實現的就是可以根據java的注解和maven插件配置來生成apidoc注釋的maven插件，即完成上面的第一步，也是最煩人的一步， 而且只支持使用spring mvc框架來開發(fā)的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>