阐明如何为现有JavaRESTAPI创建文档

阐明如何为现有JavaRESTAPI创建文档,java,rest,jersey-client,enunciate,Java,Rest,Jersey Client,Enunciate,我正在对现有的JavaREST(使用Jersey)项目使用“Enounceate”。 我已经创建了build.xml和expunciate.xml:输出文件docs.zip,但在解压缩此文件后,我有: css/dir, js/dir, robots.txt、model.html、index.html、favicon.ico、crossdomain.xml、application.wadl、apple-touch-icon.png文件 index.html和model.html没有来自java R

我正在对现有的JavaREST(使用Jersey)项目使用“Enounceate”。 我已经创建了build.xml和expunciate.xml:输出文件docs.zip,但在解压缩此文件后,我有: css/dir, js/dir, robots.txt、model.html、index.html、favicon.ico、crossdomain.xml、application.wadl、apple-touch-icon.png文件

index.html和model.html没有来自java REST代码的任何文档。 有人能帮我吗? 我没有“清晰”的经验

谢谢

--->这是REST代码示例之一:

@路径(“/{spacecraftId}/log”)

公共类UserLogHandler 实现ProcessCommunicationFacilityFailureListenerInterface, MessageCustomerInterface, IMessageAvailable {

}

--->“build.xml”文件:

<api-classes>
    <include pattern="/tps/tomcat/lib/servlet-api.jar"/>>

    <exclude pattern="com.sun.jersey.multipart.FormDataParam"/>
</api-classes>

<services>
    <rest defaultRestSubcontext="api">
    </rest>
</services>

<webapp disabled="true">
</webapp>

<modules>
  <disable-rule id="csharp.warnings"/>
  <disable-rule id="c-warnings"/>
  <disable-rule id="obj-c.warnings"/>
  <basic-app disabled="true"/>
  <c disabled="true"/>
  <csharp disabled="true"/>
  <jaxws-ri disabled="true"/>
  <obj-c disabled="true"/>
  <amf disabled="true"/>
  <gwt disabled="true"/>
  <jboss disabled="true"/>
  <object-c disabled="true"/>
  <rubby disabled="true"/>
  <jaxws-client disabled="true"/>

  <jersey disabled="false"/>

  <docs title="ICMD API"  docsDir="./" splashPackage="cmd.acmd_mdc_servlet" includeDefaultDownloads="true" includeExampleXml="false" disableRestMountpoint="true" copyright="copyright" forceExampleJson="true"/>
</modules>


--->“enounciate.xml”文件:

<api-classes>
    <include pattern="/tps/tomcat/lib/servlet-api.jar"/>>

    <exclude pattern="com.sun.jersey.multipart.FormDataParam"/>
</api-classes>

<services>
    <rest defaultRestSubcontext="api">
    </rest>
</services>

<webapp disabled="true">
</webapp>

<modules>
  <disable-rule id="csharp.warnings"/>
  <disable-rule id="c-warnings"/>
  <disable-rule id="obj-c.warnings"/>
  <basic-app disabled="true"/>
  <c disabled="true"/>
  <csharp disabled="true"/>
  <jaxws-ri disabled="true"/>
  <obj-c disabled="true"/>
  <amf disabled="true"/>
  <gwt disabled="true"/>
  <jboss disabled="true"/>
  <object-c disabled="true"/>
  <rubby disabled="true"/>
  <jaxws-client disabled="true"/>

  <jersey disabled="false"/>

  <docs title="ICMD API"  docsDir="./" splashPackage="cmd.acmd_mdc_servlet" includeDefaultDownloads="true" includeExampleXml="false" disableRestMountpoint="true" copyright="copyright" forceExampleJson="true"/>
</modules>


>
您的“包含模式”不正确。“包括”指的是类,而不是JAR。所以它可能看起来像:

 <include pattern="com.mycompany.api.resources.**"/>


另外,在调用Enounciate时,请确保所有这些类都在类路径上。

问题已修复:我需要在标记下面的中包含java包名称。
 <include pattern="com.mycompany.api.resources.**"/>