问题标签 [enunciate]

我正在为现有的 Java REST（使用 Jersey）项目使用“发音”。我有 build.xml 和 enunciate.xml：创建了输出文件 docs.zip，但解压缩此文件后，我有：css/ dir、js/ dir、robots.txt、model.html、index.html、favicon.ico、 crossdomain.xml、application.wadl、apple-touch-icon.png 文件。

index.html 和 model.html 没有来自我的 java REST 代码的任何文档。有人可以在这里帮助我吗？我没有“口齿伶俐”的经验。

谢谢，

---> 这是 REST 代码示例之一：

@Path("/{spacecraftId}/log")

公共类 UserLogHandler 实现 ProcessCommunicationFacilityFailureListenerInterface，MessageCustomerInterface，IMessageAvailable {

}

---> 'build.xml' 文件：

---> 'enunciate.xml' 文件：

我正在使用enunciate为 REST API生成Swagger文档。我的一个遗留 bean 包含一个 Map，Swagger 对此抱怨：

是否有任何注释可以放入 bean 类中，以便 Swagger 可以处理这个问题？

除此之外，有没有办法告诉 Swagger 简单地忽略该领域或整个班级？我知道 Swagger 会忽略没有@XmlRootElement注释的类，但BazBean可悲的是在另一个接受 XML 的端点中使用。

我用 enunciate 插件生成了 doc 并且它起作用了，我添加了一个源目录，用于将额外文件添加到类路径以进行编译（maven-compiler-plugin）。enunciate 不适用于这个。我如何解决这个问题？我收到此错误：[错误] 无法执行目标 org.codehaus.enunciate:maven-enunciate-plugin:1.27:assemble：组装发音应用程序时出现问题。APT 调用失败。请参阅http://jira.codehaus.org/browse/ENUNCIATE-771了解已经看到的情况。没有对此错误的解释。-> [帮助 1] [错误]

PathParam 和 FormDataParam 在 REST API 中使用，但来自 enunciate 的文档指示 PathParam 的“路径”和 FormDataParam 的“formdata”？

我有 include pattern="com.sun.jersey.multipart.FormDataParam" include pattern="javax.ws.rs.PathParam"

在 enunciate.xml 文件中。

有什么建议吗？

--->>> REST API：

--->>> 浏览器中的文档：

参数名称描述类型默认航天器Id（未提供文档）路径上传输入流（未提供文档）表单数据处置（未提供文档）表单数据文件类型（未提供文档）表单数据输入组（未提供文档）表单数据创建时间（未提供文档）表单数据校验和（未提供文档）提供的文件）formdata

顺便说一句，如何在“描述”字段中显示信息？

谢谢，

我有以下类层次结构。当我为子类生成 javadoc 时，生成的 doc 不包含从超类继承的方法的 java doc 注释。

我正在为 SubClass 生成文档。SuperClass 中的方法的文档是空的。

我正在评估 Enunciate 以生成使用 resteasy 构建的 java rest api 的文档。如何使用自定义字符串更改资源类名称？

注解@ResourceLabel 只能应用于方法。任何想法？

谢谢，法布里齐奥

我想使用发音生成 wadl。我需要为此做哪些配置更改？

根据http://jira.codehaus.org/browse/ENUNCIATE-688，enunicate 似乎支持 wadl 生成。

谢谢

我使用 jersey 和 JAX-RS 注释创建了一个 RESTful Web 服务。它还使用 enunciate 进行了记录，看起来很棒。但是，已要求将 SOAP 支持作为一个选项。我在同一个类中的这个过时的发音示例中注意到 JAX-WS 和 JAX-RS 注释。这可能吗？我自己尝试过并正确发音生成文档，但这些服务实际上不起作用。

我宁愿让完全相同的类支持两个接口，而不是两个单独的类（一个肥皂一个休息）指向业务逻辑类。这将防止可能在两个地方有代码。

这是过时软件版本的示例：http: //docs.codehaus.org/display/ENUNCIATE/A+Rich+Web+service+API+for+Spring

我正在使用 Jersey 1.8 Spring 3.0.5 Weblogic 11g

谢谢！/芯片

I have a Spring 3 application that I am trying to generate robust api documention against. I have tried a few different projects and am seeing if enunicate(http://enunciate.codehaus.org) will suit my needs including the ability to generate swagger formatted docs.

I have added the dependency to my pom.xml file as follows

and have created a simple enunciate.xml file in the root of my app as:

When I run mvn clean package against my project only a couple of classes that have jax-ws annotations are picked up.

Does anyone have a working sample of Spring/REST/JSON controllers working with enunciate?

Thanks!

我已将 REST/Spring/Jersey 项目配置为使用 enunciate 生成 API 文档。

我的 pom.xml 中的相关更改是

我的 enunciate.xml 如下

当我运行我的 maven 项目时，初始化发音时出现以下错误。如您所见，该错误不是很有帮助。任何提示我的配置可能有什么问题。

--- maven-enunciate-spring-plugin:1.28:assemble (default) @ xxx --- 初始化 enunciate。[csharp] 禁用 C# 编译，但仍会生成源代码。

调用发音：生成步骤...

构建失败

总时间：3.324s

无法在项目 xxx 上执行目标 org.codehaus.enunciate:maven-enunciate-spring-plugin:1.28:assemble (default)：组装发音应用程序时出现问题。字符串索引超出范围：0 -> [帮助 1]

要查看错误的完整堆栈跟踪，请使用 -e 开关重新运行 Maven。使用 -X 开关重新运行 Maven 以启用完整的调试日志记录。

有关错误和可能的解决方案的更多信息，请阅读以下文章：[帮助 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException