问题标签 [enunciate]

我有一个用 java 编写的 Maven-JAX-RS 项目，并使用 enunciate 自动生成每个构建的文档。到目前为止，它运行良好 - 他为我项目中的所有 REST-Endpoints 生成 api-docs。

现在我也用有用的 jdoc 编写了一些 util-classes - 但这些类不是 Endpoints - 所以，enunciate 不会包含它们。

有什么方法可以告诉他，他应该用一些附加类的 jdoc 生成附加文档？我认为应该有一种方法可以在 enunciate.xml 中手动配置它，但我找不到有效的解决方案......

我有这样的资源。Enunciate 在记录此资源时遇到问题：“不允许超过一个 JAX-RS 实体参数（所有其他参数必须使用 JAX-RS 资源参数注释之一进行注释）”。

我发现一个类似的问题报告了 http://markmail.org/message/vgvi3cljo3a2f6eh http://jira.codehaus.org/browse/ENUNCIATE-537 ，这在 1.23 版中得到了修复。

我正在使用最新版本 1.26.2 但仍然看到此错误。

当我使用 org.codehaus.enunciate.XmlTransient 进行注释时，我能够避免此错误，但这会删除整个资源（所有方法）的文档。

任何帮助都会很棒。

Maven错误堆栈：

我使用发音来记录我的 REST API。我能够正确生成文档并且已经使用了很长一段时间。

我现在的问题是......我很少有具有多个端点方法的服务类。

在这些服务方法中，有些是公共的，有些是内部使用的。我只想为那些应该公开的 Rest 方法生成文档。尽管我使用排除 api 类来排除类，但我在发音中搜索无论如何都找不到跳过一些方法。有什么办法可以做到这一点。我不想只创建单独的类 bcoz 文档。如果发音要执行此操作，则可以轻松地从现有的发音 javadoc 中改编任何其他文档工具。

我使用 Enunciate 作为 API 文档生成的 Maven 插件。我希望压缩生成的文档，但到目前为止还没有找到方法。文档已生成，但在目录中而不是在 zip 文件中。这是我的pom的摘录：

依赖：

我正在使用 Enunciate 版本 1.26.2。

你能帮我解决我在使用 Enunciate maven 插件时遇到的问题吗？问题是我的域在其他项目中，而不是在API项目中（不是包，而是java项目），所以在生成文档时，没有数据模型，但我在同一个项目中创建了一个数据模型（@XmlRootElement） API，它生成了。那么，插件能否生成其他项目中的数据模型呢？

我正在使用 Enunciate 在 Maven 项目中生成 REST API 文档。

该工件maven-enunciate-plugin生成 Web API 文档，但它忽略了 Spring 注释，例如：（@Secured来自 spring-security）

我尝试使用支持 spring 的 maven artifact 生成文档maven-enunciate-spring-plugin，但它甚至不生成 Web API 文档。

有没有办法配置 enunciate 或使用另一个 enunciate maven 插件，以便在 Enunciate 生成的文档中识别和提及来自 Spring 的注释？

我将 Enunciate ( http://enunciate.codehaus.org/ ) 用于我们的 web 服务层，我只想做一些非常简单的事情，但没有找到任何文档。

我想部署一些图像和其他静态资源，并且可以从例如http://localhost:8080/myapp/images/img01.png

我试图在images下面创建一个文件夹，src/main/resources但它并没有像我想要的那样部署（里面的所有文件/文件夹都进入 myapp/WEB-INF/classes，正如预期的那样）。

有人可以指出发音项目的静态资源在哪里？

我没有 web.xml，因为它是由发音框架自动生成的。

我正在使用 Enunciate 为我的 Resteasy 服务生成文档。我能够生成所需的文档，但我对一些自定义参数有疑问。

我们的服务接口包含一个自定义@QueryParam注释，用于列出方法实现支持的所有查询参数。我现在不想解释为什么我们决定有一个 custom @QueryParam，这只是一个架构决定。

尽管现在 Enunciate 无法识别自定义@QueryParam，所以我所有的 Resteasy 方法都没有@QueryParam参数（仅@PathParam）。

示例服务接口：

@QueryParam 类的实现：

@QueryParams 类的实现：

有没有办法告诉 Enunciate@QueryParam 在生成 HTML 文档时也考虑我的自定义？

我试图从混合类中生成清晰的文档，所有的 JAX-RS 注释，一些编码的 inn java，一些在 clojure 中。

我已经构建了一个仅依赖于包含服务类的 war 文件的 maven 项目：

我无法生成任何服务文档。

运行 mvn enunciate:docs -X 时，我看到我的课程“已注意到”：

[调试] 注意到 /.m2/repository/com/ws/scholar/0.96-SNAPSHOT/scholar-0.96-SNAPSHOT.war 中的类 WEB-INF.classes.com.ws.scholar.resources.ClientResource。

任何人都可以对我的配置提供指导或更正吗？

我正在使用 Enunciate 为多模块 Maven 项目中的 RestEasy 服务生成文档。在尝试获取响应对象属性的描述时，我在文档生成方面遇到了一些问题。

例如，如果我的服务定义为：

生成文档时，不会生成属性描述。

在所有响应对象中，我只得到（没有提供文档）。一个重要的想法是，所有响应类都位于服务所在的不同 Maven 模块中。响应类位于 UTIL 模块中。这些服务位于 EJB 模块中。

问题的原因肯定是多模块 Maven 项目，因为如果我在 EJB 模块中定义一个响应对象，该类也是，文档是完美的（也生成了描述）。

这里描述了原因和解决方案： https ://github.com/stoicflame/enunciate/wiki/Multi-Module-Projects-%28Version-1%29

尽管如此，我仍然不知道该做什么以及在不同的 pom（EJB 和 UTIL）中设置什么来解决我的问题。

任何帮助都将不胜感激。