2011-03-14 2 views
0

Я пытаюсь использовать плагин излагают для CXF для создания документации для моего REST интерфейсов через плагин Maven настроен следующим образом:излагают CXF плагин для JAX-RS

<plugin> 
    <groupId>org.codehaus.enunciate</groupId> 
    <artifactId>maven-enunciate-cxf-plugin</artifactId> 
    <!-- check for the latest version --> 
    <version>1.21</version> 
    <executions> 
    <execution> 
     <goals> 
     <goal>docs</goal> 
     </goals> 
     <configuration> 

     <!-- the directory where to put the docs --> 
     <docsDir>${project.build}/docs </docsDir> 

     </configuration> 
    </execution> 
    </executions> 
</plugin> 

Но когда я пытаюсь запустить плагин Я получаю сообщение об ошибке из командной строки с помощью команды:

mvn clean install 

ошибка:

[ERROR] BUILD ERROR 
[INFO] ------------------------------------------------------------------------ 
[INFO] 'docs' was specified in an execution, but not found in the plugin 
[INFO] ------------------------------------------------------------------------ 

Любые предложения?

Спасибо заранее,

Marc

UPDATE: Я изменил плагин к этому:

<plugin> 
    <groupId>org.codehaus.enunciate</groupId> 
    <artifactId>maven-enunciate-plugin</artifactId> 
    <version>1.21</version> 
    <executions> 
     <execution> 
     <goals> 
      <goal>docs</goal> 
     </goals> 
     <configuration> 
      <docsDir>${project.build}/docs </docsDir> 
     </configuration> 
     </execution> 
    </executions> 
    <dependencies> 
     <dependency> 
     <groupId>org.codehaus.enunciate</groupId> 
     <artifactId>enunciate-rest</artifactId> 
     <version>1.21</version> 
     </dependency> 
     <dependency> 
     <groupId>org.codehaus.enunciate</groupId> 
     <artifactId>enunciate-cxf-rt</artifactId> 
     <version>1.21</version> 
     </dependency> 
    </dependencies> 
    </plugin> 

Это работает, но мои объекты JSON возвращают типы и параметры не документированы.

ответ

1

Попробуйте вместо этого:

<artifactId>maven-enunciate-plugin</artifactId> 

Согласно docs, могут быть некоторые зависимости плагинов, которые вы должны добавить.

Я использую приведенный выше artifactId в своем проекте Maven с CXF для генерации документации с использованием Enunciate без проблем.

+0

Спасибо. Я действительно решил этот вопрос поздно вечером, используя аналогичный подход, о котором вы упомянули. Я просто не успел опубликовать обновление. – mcobery

+0

re: ваше ОБНОВЛЕНИЕ относительно объектов JSON. Enunciate, похоже, не очень хорошо обрабатывает объекты JSON. Тем не менее, я смог заставить его документировать мои возвращаемые типы JSON. См. Эту тему в списке рассылки: http://archive.codehaus.org/lists/org.codehaus.enunciate.user/msg/[email protected] – gnuf

Смежные вопросы