问题标签 [widdershins]

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 投票
2 回答
344 浏览

node.js - 如何为 OpenAPI 规范中的 widdershins 创建的代码片段指定语言?

我想使用widdershins (一个 node.js 应用程序)从OpenAPI规范生成Slate API 文档。

Widdershins 可以选择在为 API 文档生成示例代码片段时指定应包含的语言。

我可以在此选项上找到的所有帮助都是使用输出,它告诉我:

但我无法弄清楚如何准确地使用这个选项。无论我尝试什么,我都会收到相同的错误消息:

我试过了:

我也试过这个,完全按照使用帮助中给出的:

但即使这样也会产生与上述相同的错误。

根本不使用该选项时,它可以正常工作:

但是,我得到了生成的代码片段的默认值,这恰好不是我想要的。

有谁知道如何正确指定此选项?

0 投票
1 回答
360 浏览

yaml - 我可以删除响应架构表吗?只保留示例值

我正在用 YAML 的 Swagger 3.0.0 创建一个 docs Api,由 Widdershins 转换为 markdown,然后由 Slate 构建为 HTML。

我可以删除或隐藏响应架构表并继续显示示例值吗?现在我刚刚清空了响应模式表。它仍然显示该表的标题“响应模式”。

你们能帮我解决这个问题吗?太感谢了。

0 投票
2 回答
472 浏览

api - 请求正文没有出现在 OpenApi3 + widdershins + shins 的 curl 示例中

我正在为我们的 Java 端点生成 API 文档。我正在使用 widdershins 将我们的 openAPI3.0 yaml 文件转换为 markdown。然后,我使用 shins 将 markdown 文件转换为 html。我们所有端点的请求正文都没有出现在生成的 cURL 示例中。为什么是这样?这违背了拥有 cURL 示例的目的,因为复制和粘贴没有所需正文的 cURL 示例将不起作用。任何人都可以推荐一种解决方法或替代工具,以生成带有完整 cURL 示例的良好文档吗?

我们的 openAPI.yaml 文件中的示例端点...

这是我们的工具链从这个 yaml 文件生成的文档...... 在此处输入图像描述 我们想在我们的 cURL 示例中添加一行,就像下面的行(灰色突出显示)一样。这是 Widdershins 从我们的 openAPI yaml 文件生成的 markdown 文件中的一个块。我手动添加了-“d

在此处输入图像描述

这个堆栈溢出问答表明答案是不可能在使用 swagger 或 openAPI 的代码示例中包含 body 参数。这个对吗?如果是这样,为什么会这样?原因是什么?

干杯,吉迪恩