如何为 widdershins 根据 OpenAPI 规范创建的代码片段指定语言？

Question

我想使用widdershins (a node.js app) to generate Slate API docs from OpenAPI规格。

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

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

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

Answer 1

诀窍是针对生成代码段时应考虑的每种语言多次指定选项。而且，必须在选项之前指定输入文件，这与用法帮助输出所说的相反：

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

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

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

Answer 2

您可以使用 --language_tabs 标志：

widdershins --search false --language_tabs 'ruby:Ruby' 'python:Python' --summary swagger.json -o swagger.md

如何为 widdershins 根据 OpenAPI 规范创建的代码片段指定语言？

How to specify languages for code snippets to be created by widdershins from OpenAPI spec?

node.js

openapi

widdershins