Объявить генерацию документа REST API с помощью ant

Я пытаюсь интегрировать Enunicate для создания REST-документации наших существующих API.

Я получаю предупреждение «ВНИМАНИЕ: Документы неизвестного артефакта. Артефакт не будет экспортирован». при выполнении муравьиной задачи.

Есть ли что-то, чего не хватает в моей настройке?

Enunicate.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>

Спасибо

Вену


person venu    schedule 08.10.2012    source источник


Ответы (2)


Похоже, у вас может не быть библиотек enunciate в вашем пути к классам. Таким образом, Enunciate не берет ни один из своих модулей (включая модуль docs, который предоставляет артефакт 'docs').

person Ryan Heaton    schedule 18.10.2012
comment
Спасибо, Райан. Я скопировал те баночки, которые завершили сборку. Возможно, я пропустил jar модуля Doc. - person venu; 18.10.2012

Значение ArtiftId должно быть «war.file».

person Sara    schedule 06.05.2014