命令

提供了一个命令，以便以 json、yaml 或 html 格式转储文档。

1

$ php bin/console nelmio:apidoc:dump [--format="..."]

--format 选项允许选择格式（默认为：json）。

默认情况下，生成的 JSON 将被美化格式化。如果您想生成没有空格的 json，请使用 --no-pretty 选项。

1
2

$ php bin/console nelmio:apidoc:dump --format=json > json-pretty-formatted.json
$ php bin/console nelmio:apidoc:dump --format=json --no-pretty > json-no-pretty.json

每种格式都可以覆盖 API url。如果静态文档未托管在 API url 上，则很有用

1

$ php bin/console nelmio:apidoc:dump --format=yaml --server-url "http://example.com/api" > api.yaml

例如，要生成文档的静态版本，您可以使用

1

$ php bin/console nelmio:apidoc:dump --format=html > api.html

默认情况下，生成的 HTML 将添加 sandbox 功能。如果您想生成没有 sandbox 的文档静态版本，或配置 UI 配置，请使用 --html-config 选项。

• assets_mode - `cdn` 从 CDN 加载资源, `offline` 内联资源
• server_url - API url，如果静态文档未托管在 API url 上，则很有用

• swagger_ui_config - 配置 Swagger UI

  • "supportedSubmitMethods":[] 禁用 sandbox

• redocly_config - 配置 Redocly
• stoplight_config - 配置 Stoplight

1

$ php bin/console nelmio:apidoc:dump --format=html --html-config '{"assets_mode":"offline","server_url":"https://example.com","swagger_ui_config":{"supportedSubmitMethods":[]}}' > api.html