问题标签 [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 回答
870 浏览

json - 发音示例 JSON 将地图显示为数组

Enunciate docs 模块中的示例 JSON 将地图显示为对象数组。

例如,我有一个像这样的对象:

来自 enunciate 的示例 JSON 如下所示:

我希望示例 JSON 看起来像:

看起来 GenerateExampleJsonMethod 在看到 Map 时总是在创建 ArrayNode。有没有办法获得预期的 JSON?

我正在使用发音版本 1.26.2

0 投票
1 回答
1609 浏览

gradle - 如何在使用 gradle 时将 jar/war 依赖项添加到 ant 文件集?

我有一个 gradle 配置,它执行我对战争的编译和打包。

我有一个 ant 脚本,我想在战后调用enunciate.codehaus.org。ant 脚本需要访问捆绑到战争中的罐子。

摇篮配置:

发音 ant 文件的一部分:

如何将战争的依赖项添加到此文件集中?当 gradle 编译战争时,罐子(即依赖项然后打包到战争中)是否放在我可以参考的地方?

我认为它与使用依赖项或配置类有关,但似乎无法将它们结合在一起。

0 投票
0 回答
495 浏览

enunciate - 发音 JSON Doc 示例不显示根元素

我正在使用发音 1.26.2。在 XML/JSON 示例中,XML 代码示例是正确的,但 JSON 示例缺少根 (SerialPorts)

XML:

JSON:

JSON 和 XML 的真实 Rest 调用(使用 CXF)的输出是正确的。我想我缺少正确的文档输出的清晰 JSON 注释/配置?

0 投票
1 回答
598 浏览

generics - 用 Iterable 和泛型阐述文档问题

我正在尝试使用 enunciate 为我的基于 Jersey 的 REST API 重新生成文档。遇到几个绊脚石:

Enunciate 似乎无法插入 Iterable。在我的文档中,我只得到“元素:(自定义)”。请注意,项目类型使用@XmlRootElement 和@JsonRootType 进行注释。

同样,对于此代码:

我为方法参数(注意:T 具有扩展限制)和返回类型(其中 Response 为:javax.ws.rs.core.Response)都获得了“元素:(自定义)”。此外,enunciate 似乎无法弄清楚返回的媒体类型:它列出了 XML、JSON 和 *(想想看,我不确定我到底想要什么,但我知道不是那样.)

有任何想法吗?

0 投票
1 回答
152 浏览

c# - enunciate 是否支持为基于 REST 的接口生成 C# 客户端?

我有一个带有一些基于 REST 的接口的项目,并希望为它们生成 C# 代码。可以发音帮助我这样做还是仅适用于 WS* 接口?

在调试模式下运行 enunciate 使用mvn -X我可以看到消息:

你知道任何其他可以用来做这件事的工具吗?

最好的,

0 投票
2 回答
1173 浏览

java - 无法使用 ant 任务创建发音 Java 客户端

我正在尝试使用发音 v1.26.2 ant 任务创建 java-client 库。问题是每次我尝试这样做时,都会收到以下警告消息:

我检查了 java-client enunciate jar 是否在类路径上,并且 enunciate 甚至说它在输出中找到了它。

所以我不确定该怎么做。我试过用谷歌搜索发现 SO 只有几个问题要表达,似乎没有人回答我的问题。这是我的带有相关行的 ant 脚本:

注意:文档导出被调用并正确导出,没有问题。包含的代码编译没有问题。我似乎无法发现为什么 ant 脚本不想导出 java-client 库。我尝试将 artifactId 的名称更改为几个不同的值,包括:java.client.library.binaries、java-client.library、enunciate-java-client 以及所有其他没有最终结果的东西。我尝试使用 enunciate.xml 配置文件,但似乎没有帮助。这是我尝试使用的xml:

0 投票
2 回答
627 浏览

xsd - Enunciate 不会从 xs:documentation on xs:elements 生成描述

我们正在使用 maven-enunciate-plugin 版本 1.26.2,并且在生成文档时遇到了问题。我们通过以下方式向 XSD 添加了注释:

第一个集合在发音页面上被正确解析和输出,但是其中各个元素的所有注释都完全丢失了。奇怪的是,这只发生在元素序列中,但枚举工作得很好。

我尝试了几种不同的格式化文档的方法,包括使用 CDATA 块,但似乎没有任何效果。

我错过了什么?如果需要,我可以包含更多的 XSD。

0 投票
1 回答
858 浏览

java - 如何在 WAR 中打包文档工件

我已经集成了 maven-enunciate-plugin,以便它在构建期间生成文档并将其输出到目标目录下的 docs 目录。由于我是 Maven 新手,我想知道配置我的构建的理想方法是什么,以便它将 docs 目录打包到我构建的 WAR 工件中。目前它被留在WAR之外。谢谢,迈克

0 投票
1 回答
1009 浏览

java - Enunciate 能否为处理泛型类型的 API 生成文档?

给定一个抽象的通用 Resource 类和一个具体的实现:

似乎在为 生成文档时PersonResource,Enunciate 并没有发现get()返回 a的事实Person

  1. 人员未在数据模型 > 数据类型部分中列出。

  2. 在 GET 部分下,响应正文将元素类型显示为“(自定义)”。

这些问题是因为使用泛型作为实体类型吗?有没有办法提示 Enunciate 真正的类型是什么,以便正确生成文档?

在此处输入图像描述

0 投票
2 回答
425 浏览

java - JAXWS-RI 模块需要每个服务接口的实现

我有服务及其实现的接口......

我的接口有一个注释,将服务名称指定为已实现该接口的服务名称..但是该服务没有指定端点接口的注释?

那么这会导致 wsdl 生成失败吗?

我收到错误消息: 1> 端点接口没有实现!它不会被部署... 2> JAXWS-RI 模块需要每个服务接口的实现

我正在使用 enunciate 来生成 Web 服务。

我的代码是这样的: