Enunciate CXF плагин для JAX-RS - PullRequest
Новая
       43

Enunciate CXF плагин для JAX-RS

0 голосов
/ 14 марта 2011

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

<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] ------------------------------------------------------------------------

Есть предложения?

Заранее спасибо,

Марк

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 Ответ

1 голос
/ 14 марта 2011

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

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

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

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

...