问题标签 [enunciate]

我已经使用 enunciate 成功地为我的端点创建了文档。这是来自端点的示例：

在 JAX-WS 中通过Message映射Jackson并具有以下结构：

虽然这适用于发音，但我在文档中的任何地方都看不到@Produces，也看不到@Consumes。是否有可能以其他方式“标记”域类——不是通过@XmlRootElement，而是通过一些外部配置文件？我不热衷于仅仅为了发音而改变域（即使涉及注释）。

我也没有看到@DocumentationExample注释（或作为示例指定的值）。是否可以提供多个示例？

谢谢。

我有几个 RESTful Web 服务，我想使用Enunciate 1.25和 Maven 来记录。如果我在没有自定义 enunciate.xml 的情况下构建，所有客户端库都会按预期构建。

一旦我添加了我的自定义 enunciate.xml，就不会生成 java 的客户端库

我可能做错了什么或遗漏了什么？

Enunciate 从@Path注解生成 REST 资源名称。这并不是真正的用户友好，尤其是对于许多具有长 URI 的资源。

有没有办法为 REST 资源提供替代名称？

代替：

就像是：

这里和这里有两个类似的问题，但没有给出足够的答案。

我发现我可以使用Enunciate为 RestEasy 服务创建 WADL。所以我试了一下。

在我的一项服务中，我有一个映射到 HTTP GET 的方法，我正在使用如下所示

Enunciate 在生成 WADL 之前对服务方法执行验证，并抛出此错误并失败

@Form 是 RestEasy 特定的注解，而 Enunciate 只能解析 JSR-311 注解。

有没有人做过类似的事情？有没有人成功地使用 Enunciate 为 RestEasy 服务生成文档？有没有其他选择？

我正在努力解决我认为非常简单的事情——为一组已经存在的 REST 服务生成文档，这些服务基本上只是带有JAX-RS注释的 POJO注释。我使用Jersey作为实现提供者。REST API 作为Spring Web 应用程序的一部分进行部署。

我只想为 REST 服务 POJO 生成文档，所以我的enunciate.xml配置是这样的：

我已经按照enunciate文档中的建议配置了我的pom.xml ：

但是当我运行时mvn enunciate:docs，我收到以下构建错误：

我想不通，我做错了什么。有任何想法吗？

我现在正在学习如何通过这篇文章http://docs.codehaus.org/display/ENUNCIATE/A+Rich+Web+service+API+for+Wicket来集成检票口和发音。但结果与那个网站不同。api 文件夹已成功生成，但是当我指向 xml 或 json 或 rest 或 soap 中的 API 时，我无法访问它们。

以下是我在 cmd 中尝试“mvn:jetty-run”时得到的信息：

我认为，我尝试的发音有问题，但我不知道我应该在哪里检查，因为如果我认为我已经完成了 codehaus 告诉我的操作。你能引导我走上正确的道路吗？

感谢您的关注。

目前 Enunciate 生成 REST API 文档，但响应正文不包含有关响应的 JSON 结构的信息。据我了解，如果我包含由 Jersey 序列化/反序列化为 JSON 的数据实体的类，则 enunciate 将能够生成该文档。

数据实体位于不同的模块中，该模块与其源代码一起打包，如发音文档 -多模块项目中所建议的那样

这就是我的enunciate.xml的样子：

这就是文档的样子：

如您所见，响应正文仅包含element: (custom).

如何使其包含响应的 JSON 结构？

Enunciate主页仅提供了如何为GWT-RPC-API创建客户端库的线索，但我已经开发了一个 REST API，所以如果 JSON 覆盖也可以使用 Enunciate 生成，那就太好了。（我也用它来创建其他库。） Enunciate 说该功能已经存在，但我找不到它。

我有一个使用 jersey+enunciate 的休息项目，现在我想用恶意字符串测试端点。该程序的输出在我看来就像 JacksonParseException 但没有详细信息或堆栈跟踪：

我想捕获异常，但即使声明默认错误页面也无法完成工作，球衣中的 ExceptionMapper 也无法获得它。（在我看来，它之前在容器中被捕获并记录但没有被重新抛出）。

您如何记录 REST API？不仅是关于资源是什么的文档，而且实际上是在请求中发送的数据是什么，以及在响应中发回的数据是什么。知道某些东西期望发送 XML 并返回 XML 是不够用的；或 JASN；管他呢。您如何记录在请求中发送的数据以及在响应中发送回的数据？

到目前为止，我能找到的最好的是 Enunciate 工具，您可以在其中记录您的 REST API 和数据元素。Enunciate 是否适合此类型的工具，我是否错过了任何其他提供此功能的工具，我应该看看？

我的 REST API 的使用者可以使用任何语言 python、Java、.NET 等