问题标签 [enunciate]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
141 浏览

enunciate - 使用 enunciate 创建所有 API 调用的索引

我使用 Jersey 和 Jackson 开发了一个不太 RESTful 的 API。所有API调用都使用@Path@GET/@POST和. 我设法使用enunciate生成了一个不错的 API 文档。@Produces@Consumes

问题是:

是否可以告诉 enunciate 创建一个包含所有 API 调用的索引的 HTML 页面?

0 投票
1 回答
497 浏览

maven-3 - 用 maven 阐明多次运行时间

我正在使用 enunciate 1.27 和 maven 3.0.4 。
当我多次运行 enunciate 时出现我的问题:

我以这种方式执行发音:

当我执行一次发音时(我的意思是省略 number2)一切正常。
我猜第二次执行中的“generateDir”设置不正确。当我省略它时,什么都没有生成(消息是:everythis 出现最新的);在当前配置下,会抛出 NullPointerException。

任何想法?
谢谢。

0 投票
1 回答
140 浏览

documentation - 阐明文档 修改或删除“生成者”语句?

当我在每个页面上使用 Enunciate 生成文档时,它有权:

我可以修改该字符串或将其删除吗?

0 投票
1 回答
518 浏览

maven - Maven 将发音插件输出部署到不同的项目

我目前正在使用“发音”插件来为网站生成 API 文档。

我想将文档从 API 分离到不同的项目中,这些项目将作为持续交付的一部分一起部署到同一个 tomcat 服务器。

所以我现在需要的是修改将“知道”另一个项目并将输出部署到它的 maven 配置。

这是我现在拥有的清晰的 maven 插件配置:

所以现在我真的不明白如何在<docsDir>

0 投票
2 回答
1174 浏览

ant - 升级到 Java 7 后,Ant 任务中断

我使用 enunciate (1.27) 生成其余文档作为 ant 构建 (1.9.2) 的一部分,如下所示:

在我迁移到 java 7 之前,这一切都很好。从那时起,我得到:

我尝试使用 javacArgument 指定 java 7(使用 -source 7 和 -source 1.7):

但我收到以下错误:

这是我的配置文件(enunciate.xml):

看起来发音任务正在为 javac 指定 1.5 版,但我找不到在哪里或如何覆盖它。有人知道我在做什么错吗?

我使用 enunciate 来生成文档,而不是提供其余服务。

0 投票
1 回答
340 浏览

jersey - 使用 @POST @FormParam + String 数据对 Jersey API 进行发音验证失败

我正在评估 enunciate 以记录我们的 REST API,但我在验证步骤时遇到了问题:

除了 @FormParam 绑定之外,这种接受 POST 数据作为 String 实体的构造是由 Jersey 支持的,所以不确定为什么 enunciate 会窒息呢?这不符合 JAX-RS 吗?

如果出现问题,这对于捕获完整的帖子数据以进行审计非常有用。有没有办法配置发音来忽略这个参数?

如果没有,是否有其他方法可以以保持发音愉快的方式捕获帖子数据?我不愿意去 MultivaluedMap 因为字符串化过程可能不会导致传入的确切字符串......

谢谢!

0 投票
1 回答
734 浏览

jaxb - 如何在发音中记录类型?

如何获取生成的发音文档中填充的类型的描述字段?

我们正在使用 jaxb2-maven-plugin 从 jaxb 生成类。无论我如何使用<xsd:documentation></xsd:documentation>

它在生成的类中被覆盖。我可以从这个插件中禁用这个自动生成的 javadoc 吗?或者,enunciate 真正希望我做什么让我在现场记录?

请注意,我在类级别/类型上写的注释确实出现在生成的类和明确的生成文档中。

我们正在使用 enunciate (v.1.26.2) 和 jaxb2-maven-plugin (v. 1.5)

0 投票
2 回答
21169 浏览

maven - 我可以在 Gradle 中使用 Maven 插件(发音)吗?

我有一个名为 enunciate 的 maven 插件,可以生成很好的 API 文档。我宁愿使用 Gradle 作为我的构建工具,但它看起来在这方面受到限制,或者我可能只是不知道如何使用它。

我想知道是否可以在 gradle 中以某种方式使用 maven 插件(发音)?我必须编写一个蚂蚁脚本并调用它吗?到目前为止,我找不到发音的 gradle 示例,所以我猜它不受支持?

0 投票
1 回答
54 浏览

objective-c - /obj-c/target/enunciate/gen/下的源文件来自哪里?

我一直在我的 Mac 上使用 enunciate。由于安装了最新版本的 Xcode 命令行工具,我在enunciate.menunciate-common.m. 它们是非常基本的语法错误,我可以通过进入/obj-c/target/enunciate/gen/obj-c/目录并编辑有问题的文件轻松解决。所以,这不是我的问题。

问题是,每次我运行 amvn clean install时,我所做的更改都会被丢弃。所以,我想知道enunciate.menunciate-common.m文件是如何生成的,这样我就可以从源头上解决问题。我试图自己弄清楚,但无济于事。我对 Maven 不太熟悉,所以我认为我遗漏了一些明显的东西——比如当 Maven 执行该阶段时,.m文件是从其他地方的存储库中提取的吗?compile

0 投票
1 回答
515 浏览

enunciate - 问题类已显式导入,但在类路径中找不到。无论如何我们都会尝试导入它

我试图将模型类导入到发音文档中,但我在 Maven 日志中得到以下信息:

我试图在我的发音生成文档中包含请求和响应类。但是,我得到的只是以下内容:

发音.xml

pom.xml

另外,第二个问题。有没有办法在文档中包含示例 JSON 请求和响应?