命令

提供了一个命令来转储文件欧宝官网下载appjson,yaml或html。

1

php bin /控制台nelmio:美元apidoc:转储(=——格式“…”]

的- - -格式选项允许选择格式(默认是:json)。

默认情况下,生成的JSON将pretty-formatted。如果你想生成一个json没有空格,使用——no-pretty选择。

1 2

php bin /控制台nelmio:美元= json > json-pretty-formatted apidoc:转储——格式。json$ php bin/console nelmio:apidoc:dump --format=json --no-pretty > json-no-pretty.json

每个url格式可以覆盖API。有用如果不驻留在静态文档API网址欧宝官网下载app:

1

美元php bin /控制台nelmio: apidoc:转储——= yaml格式——服务器url“http://example.com/api”> api.yaml

例如生成一个静态版本的文档可以使用:欧宝官网下载app

1

php bin /控制台nelmio:美元= html > api.html apidoc:转储——格式

默认情况下,生成的HTML将添加沙箱功能。如果你想生成一个静态版本的文档没有沙箱,或配置界面配置,使用欧宝官网下载app——html-config选择。

• assets_mode——从cdn的cdn负载资产,“网下”内联资产
• server_url- API url,有用的API如果不驻留在静态文档的u欧宝官网下载apprl

• swagger_ui_config- - - - - -配置的界面

  • “supportedSubmitMethods”: []禁用沙箱

1

美元php bin /控制台nelmio: apidoc:转储格式= html——html-config”{assets_mode”:“离线”、“server_url”:“https://example.com”,“swagger_ui_config”: {“supportedSubmitMethods”: []}}”> api.html