问题标签 [enunciate]

我可以针对我的多模块 pom 运行 mvn enunciate:docs，其中模块是服务的完整实现，并且站点是在每个服务下创建的（例如 service1/rest/api/target/site/wsdocs/index.html ) 但我希望通过 enunciate 将所有其他 API 链接在一个页面中。

我只使用 enunciate 来生成 API 和示例 xml/json 消息体。

这可能吗，还是我必须自己用一些脚本或你有什么来创建网站？

谢谢。

我能够通过 enunciate 生成 REST API 文档，我非常喜欢它为消息正文生成的示例 xml 和 json。我找不到如何让它为列表、数组、地图等生成那些。

我正在使用 maven，配置了 enunciate 插件（常规）和构建插件 maven 节点中的 docs 目标。

这可能吗？

谢谢。

I'm hitting the error "No support yet for multidimensional arrays" when running docs goal for maven plugin enunciate. Is there a way I can avoid it bombing out the process (ie. generate the rest of the docs for the API)?

I've tried @org.codehaus.enunciate.doc.ExcludeFromDocumentation on the API method returning the class with double array. I've tried @org.codehaus.enunciate.XmlTransient on the class with the double array.

I have since seen in enunciate documentation where those only affect whether they display on docs, not compilation.

I'm happy to hear any ideas you have!

Thanks.

Edit: The best I could do was dump project to temp directory, rip out all modules that aren't necessary to reach the api, delete the class with double array, and replace that part of the REST api's java method signature with String. This allows me to at least create the api document page via enunciate and give a description via javadoc. But, I'd love to have a more elegant solution, so please share if you know of one :)

Edit 2: Example pom:

Files located src/main/java/com/company/services/user/rest:

enunciate.xml:

Enunciate自动生成cxf-jaxrs-servlet.xml文件并指定：org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider作为JAX-RS提供者。此类已更改为com.fasterxml.jackson.jaxrs.JacksonJaxbJsonProvider在最新Jackson库中。如何在自动生成的文件Enunciate中将新类指定为提供者？JSON或者我可以Enunciate使用用户提供的XML文件吗？

我在为 CXF REST 服务 API 项目集成 enunciate 和 ant 时遇到错误。方法 getFeeItemsByCapID() 中存在错误。我试图在源代码中找到答案，但没有结果。谁对错误有任何想法？谢谢你的帮助。如果您有任何提示。

蚂蚁脚本

发音.xml

Java 代码

例外：

源代码：

我有一个完全工作且经过测试的 REST API。要创建我正在使用的文档，请说明。

请求和响应对象是使用 jaxb 从 xsd 文件生成的。在文档中，响应对象被识别，但我的请求正文的类型是(custom)。

请求正文封装在 JAXBElement 中

代码示例：

是否有类似@TypeHint指定请求对象类型的注释？

我正在使用发音并希望从文档中排除某些 jaxb 生成的类。如何才能做到这一点？

是否可以通过 xsd 添加 org.codehaus.enunciate.XmlTransient 注释？

提前致谢。

我正在尝试集成 Enunicate 以生成我们现有 API 的 REST 文档。

我收到警告“警告：未知工件 'docs'。工件将不会被导出。” 蚂蚁任务执行时。

我的设置中是否缺少某些内容？

enunicate.xml 是：

相关的蚂蚁片段是：

谢谢

金星

我发现 ennuciate 擅长记录我们的 JAXB REST Web 服务，但似乎很少有关于如何调整生成的输出的文档。

是否有一个明确的注释列表，我们可以使用它来描述 Web 服务的参数和可接受值的列表。

目前尚不清楚文档生成代码如何将类拆分为数据类型和数据元素

谢谢

戈登

我正在尝试运行 maven-enunciate-plugin:1.26.2:docs 并面临 NUllPointerException。

我唯一想要的是这里描述的文档生成http://docs.codehaus.org/display/ENUNCIATE/Documentation+Only，所以我的 pom.xml 是：

但是，它启动：

有什么建议吗？