0

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

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

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

widdershins [options] {input-file|url} [[-o] output markdown]

Options:
[...]
  --language_tabs       List of language tabs for code samples using
                        "language[:label[:client]]" format, for example:
                        "javascript:JavaScript:request"                  [array]
[...]

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

Not enough non-option arguments: got 0, need at least 1

我试过了：

widdershins --language_tabs="shell,ruby" foo.yaml
widdershins --language_tabs "shell,ruby" foo.yaml
widdershins --language_tabs=shell,ruby foo.yaml
widdershins --language_tabs="[shell,ruby]" foo.yaml
widdershins --language_tabs="[{ 'shell': 'Shell' }, { 'ruby': 'Ruby' }]" foo.yaml

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

widdershins --language_tabs="javascript:JavaScript:request" foo.yaml
widdershins --language_tabs=javascript:JavaScript:request foo.yaml

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

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

widdershins foo.yaml

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

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

4

2 回答 2

2

诀窍是为生成片段时应考虑的每种语言多次指定选项。此外，必须在选项之前指定输入文件，这与使用帮助输出所说的相反：

widdershins foo.yaml --language_tabs 'python:Python' --language_tabs 'ruby:Ruby'

另一种可能，与其他选项更一致，是添加一个--来终止选项列表：

widdershins --language_tabs 'python:Python' --language_tabs 'ruby:Ruby' -- foo.yaml
于 2018-04-10T08:48:30.293 回答
0

您可以使用该--language_tabs标志：

widdershins --search false --language_tabs 'ruby:Ruby' 'python:Python' --summary swagger.json -o swagger.md
于 2020-06-30T19:25:13.627 回答