阐述使用ant生成REST API文档

Question

我正试图集成Enunicate来生成我们现有的API的REST文档。

我得到一个警告“警告:未知工件‘文档’。不会导出工件。当执行ant任务时。

我的设置中是否缺少什么？

.xml的解释是：

<?xml version="1.0"?>
<enunciate label="Empath REST api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://enunciate.codehaus.org/schemas/enunciate-1.23.xsd">
<modules>
    <!-- Docs -->
    <docs splashPackage="com.parc.perceptum.common" title="Empath REST API"
        copyright="PARC">        <download name="License" file="LICENSE.txt" description="The license file governing the use of this API." />
    </docs> 
</modules>
</enunciate>

相关的蚂蚁片段是:

<path id="enunciate.classpath"> 
    <fileset refid="project.libs"/> 
    <fileset dir="${java.home}"> 
            <include name="lib/tools.jar"/> 
    </fileset> 
    <pathelement path="${servlet-lib}" />
    <pathelement path="${mysql-lib}" />
</path>

<taskdef name="enunciate" classname="org.codehaus.enunciate.main.EnunciateTask"> 
    <classpath refid="enunciate.classpath"/>
</taskdef>

<target name="new-rest-api-doc">
    <enunciate basedir="src/com/parc/perceptum/">
      <include name="**/*.java"/>
      <classpath refid="enunciate.classpath"/>
      <export artifactId="docs" destination="restapi"/>
    </enunciate>
</target>

谢谢。

维努

Answer 1

artifactId的值应为“war.file”

Answer 2

看起来您的类路径上可能没有发音库。因此，Enunciate不使用任何模块（包括提供“docs”工件的docs模块）。