问题标签 [enunciate]

我的第一个工作任务是进行清晰的构建以生成 Rest API 文档。我正在使用 Ant 构建工具。我正在我们的一个名为 xmbo 的模块上应用发音。我遇到一个错误：

java.util.zip.ZipException: ZIP 文件在构建过程中必须至少有一个条目。

我已经根据http://enunciate.codehaus.org/executables.html#ant为发音任务定义了以下类路径（我在下面的代码中注释掉了 spring 模块，因为它是可选的）

阐明目标：

（在复制任务下包含和排除，我没有在这个页面中给出完整的名称，但在我的 xml 文件中它是正确的）。目标 generate_api_doc 依赖于目标 compile_xmbo，它编译并创建需要“阐明”的 jar。

发音.xml：

（主机是我们的服务器地址）

一旦我通过命令行调用模块目标 deploy_api_doc 运行构建，它就会给出 java.util.zip.ZipException: ZIP 文件必须至少有一个条目。

我做错什么了吗？

问题是如何让 java 1.8 和 maven-enunciate-plugin 一起工作？

使用 maven 插件org.codehaus.enunciate version 1.29和 OSX JDK1.7.0_25一切都很好。发音取决于apt，我看到这个运行时警告 1.7.0_25

[INFO] 调用发音：生成步骤...

警告：计划在下一个主要 JDK 版本中删除 apt 工具及其相关 API。这些特性已被 javac 和标准化注释处理 API、javax.annotation.processing 和 javax.lang.model 所取代。建议用户迁移到javac的注解处理特性；有关更多信息，请参见 javac 手册页。

当更改1.8.0_05构建失败时...

apt确实消失了，因此有关com.sun.mirror.apt.AnnotationProcessorFactory未找到的运行时错误。

mvn install -pl myProject -e -X

...

在尝试找到解决方案 2 小时后，我完全迷失了方向。

对于我的项目，我需要发音 ( http://enunciate.codehaus.org/ ) 为应用程序的 RESTFul api 生成文档。之前使用 1.28 版本的 maven-enunciate-plugin 效果很好，但是突然我在执行 enunciate 的 maven 目标时在插件中遇到了 NullPointerException （但该异常是另一个需要整理的故事..）

无论如何，我看到 1.29 有更新，所以我想我试试看。

在 maven 构建过程中发音的正常配置基本上是这样的：

遗憾的是 1.29 目前似乎不在 maven 中央存储库中，但添加了一个手动依赖项和存储库，如下所示：

实际上将 1.29 下载到我的本地 m2-repo 中（我可以看到所有文件......）。无论如何，一旦我尝试使用上述插件，maven 将无法正确执行，但会退出：

插件 org.codehaus.enunciate:maven-enunciate-plugin:1.29 或其依赖项之一无法解析：无法读取 org.codehaus.enunciate:maven-enunciate-plugin:jar:1.29 的工件描述符：找不到 org http://repo.maven.apache.org/maven2中的 .codehaus.enunciate:maven-enunciate-plugin:pom:1.29被缓存在本地仓库中，直到 Central 的更新间隔已过或更新后才会重新尝试解析被迫 -> [帮助 1]

为什么 maven 没有使用正确下载的依赖项？

任何帮助都非常感谢，因为我已经浪费了很多时间来摆弄它。

我面临的问题与该线程中描述的问题类似：

Enunciate 能否为处理泛型类型的 API 生成文档？

我正在使用启用了 spring 和 swagger 模块的 enunciate 1.28。

所以考虑一个抽象资源类，如：

和一个具体的实现：

1. 对于 GET 和 POST 方法，未使用正确的“作者”数据模型生成发音文档。

对于 GET 我有：

和 POST ：

2. 对于 Swagger，作者模型未显示为 GET 的 JSON 模型为“responseClass”，而 POST 为正文“dataType”。相反，我得到了两者的字符串。

但是 Author 模型列在 swagger/ui 目录中生成的 AuthorResource.json 中。responseClass 和 dataType 字段只是缺少模型的链接。

手动更换：

成功了。

注意：我确认在我这边 Author 是用 @XmlRootElement 注释的，并且 Author 类包含在我的类中<api-import pattern="com.my.package.**"/>，它位于类路径上的 jar 文件中。

在这种情况下如何调整 Enunciate/Swagger 文档生成的任何想法？

谢谢

有没有办法阐明文档 bean 验证规则？

它是否适用于通过注解进行 bean 验证和通过 xml 配置进行 bean 验证？

Enunciate 目前没有 gradle 插件 ( https://jira.codehaus.org/browse/ENUNCIATE-815 )。有什么方法可以手动从 Gradle 触发文档的构建？

我正在尝试为我的 JAVA restful webservice 项目使用 enunciate 插件生成 REST 文档。每当我使用 Maven 构建运行 POM.xml 时。我收到以下警告并且文档根本​​没有生成..

[警告] [文档] 未找到启动包 com.layer.rest.service.interfaces。不包括飞溅文档。

有什么线索吗？

我正在定制一个appfuse 3.0.0 Web Service Only 工件。尝试向我的 Web 服务添加检查的异常时，我遇到了这个堆栈跟踪：

我的发音版本是 1.28，我在 enunciate.xml 中启用了 cxf 模块：

我已经使用JAX-WS Spec进行异常抛出。

任何帮助表示赞赏。

Enunciate 是否支持以下混合模式：

1. 它处理可用的类以生成文档。
2. 从一些 JSON/XML/TEXT 文件中读取手册文档以添加到 (1) 中生成的文档中

如果 Enunciate 不支持这一点，是否有其他工具可以满足我们的需求。

在尝试使用 Enunciate 为 Java 项目生成文档时，我收到了以下堆栈跟踪。我正在使用 JDK 1.8.0_25 和 Enunciate 1.30 RC1。

这个问题的原因是什么？