使用 Enunciate 生成 API 文档时出错

Question

我创建了一个 Web 服务，并希望为 API 生成文档。所以我查看了 Enunciate 下载了 maven enunciate 插件。但是，我在编译时收到以下错误，因为 webservice 注释位于 POJO 实现的接口类上，而不是 POJO 本身。

I don't want to clutter the POJO by adding the annotations to it.  

    artifact org.mortbay.jetty:maven-jetty-plugin: checking for updates from central
[INFO] [enunciate:docs {execution: default}]
[INFO] initializing enunciate.
[INFO] invoking enunciate:generate step...
[WARNING] Validation result has errors.
/Users/vkumar/IdeaProjects/identity-service/trunk/src/main/java/com/foobar/ids/service/IDService.java:17: [jersey] Jersey doesn't support interfaces as root resources. 
The @Path parameter will need to be applied to the implementation class.

public interface IDService {
       ^
1 error
[INFO] ------------------------------------------------------------------------

pom.xml 片段在这里

        <plugin>
          <groupId>org.codehaus.enunciate</groupId>
          <artifactId>maven-enunciate-plugin</artifactId>
          <!-- check for the latest version -->
          <version>1.20</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>

Answer 1

这是泽西岛的限制。您必须注释您的实现类。

然而，CXF 没有提出相同的要求，因此您可能需要考虑使用 JAX-RS 的 CXF 实现而不是 Jersey 实现：

    <plugin>
      <groupId>org.codehaus.enunciate</groupId>
      <artifactId>maven-enunciate-cxf-plugin</artifactId>
      <!-- check for the latest version -->
      <version>1.20</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>