如何使用ANT Build Tool通过enunciate生成REST API文档?

时间:2014-05-21 11:15:01

标签: ant build enunciate

我在工作中的第一个任务是执行一个enunciate构建来生成Rest API文档。我正在使用Ant Build Tool。我正在我们的一个名为xmbo的模块上应用enunciate。我遇到了一个错误:

  

java.util.zip.ZipException:ZIP文件在构建过程中必须至少有一个条目。

我根据http://enunciate.codehaus.org/executables.html#ant为enunciate任务定义了以下类路径(我在下面的代码中注释掉了spring模块,因为它是可选的)

<path id="enunciate.base.classpath">
  <fileset dir="${enunciate.home}/lib">    
    <include name="*.jar"/>
    <exclude name="enunciate-jersey-1.28.jars"/>
    <exclude name="enunciate-jersey-rt-1.28.jar"/>
    <exclude name="enunciate-xml-1.28.jar"/>
    <exclude name="enunciate-java-client-1.28.jar"/>
    <exclude name="enunciate-jaxws-ri-1.28.jar"/>
    <exclude name="enunciate-jaxws-support-1.28.jar"/>
    <exclude name="enunciate-jaxws-support-1.28.jar"/>
   </fileset>

     <!--include (optional) spring module-->
    <!--<fileset dir="${enunciate.home}/lib/modules/spring">-->
      <!--<include name="*.jar"/>-->
    <!--</fileset>-->
</path>

宣布目标:

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

<target name="generate_api_doc" depends="compile_xmbo"> 
  <delete dir="${enunciate.src.dir}"/> 
  <mkdir dir="${enunciate.src.dir}"/> 
  <delete dir="${xmbo.build.dir}/stage/xmbo/webservices/war/docs"/> 
  <mkdir dir="${xmbo.build.dir}/stage/xmbo/webservices/war/docs"/> 
   <copy todir="${enunciate.src.dir}"> 
     <fileset dir="${xmbo.src.dir}"> 
       <include name="com/../webservice/**"/> 
       <include name="com/../wso/**"/> 
       <include name="com/../constants/**"/> 
       <exclude name="com/../**"/> 
       <exclude name="com/../**"/> 
     </fileset> 
   </copy> 

 <enunciate basedir="${enunciate.src.dir}" configFile="${config.dir}/properties/enunciate.xml"> 

    <include name="**/*.java"/> 
    <exclude name="**/client/**,**/xdm/**"/> 
    <classpath refid="enunciate.full.classpath"/> 

    <export artifactId="docs" destination="${xmbo.build.dir}/stage/xmbo/webservices/war/docs"/> 
    <javacArgument argument="-g"/> 
  </enunciate> 
 </target> 

(在复制任务中包含和排除,我没有在此页面中给出完整的名称,但在我的xml文件中它是正确的)。 目标generate_api_doc依赖于目标compile_xmbo,它编译并创建所需的jar文件以“发出”。

Enunciate.xml:

<?xml version="1.0" encoding="UTF-8"?>
  <enunciate>
    <api-classes>
  <exclude pattern="**/xdm/**/*.java"/>
  <exclude pattern="com.xactly.xdm.*"/>
  <exclude pattern="com.xactly.xbpm.****"/>
    </api-classes>
    <deployment protocol="http" host="http://.../xmbo/xmbows" context="/api"/>
    <webapp doCompile="false" doLibCopy="false"/>
  </enunciate>   

(主机是我们的服务器地址)

一旦我通过命令行调用模块目标deploy_api_doc来运行构建,它就会产生java.util.zip.ZipException:ZIP文件必须至少有一个条目。

我做错了吗?

0 个答案:

没有答案