mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-02 15:51:48 +03:00
22 lines
654 B
ReStructuredText
22 lines
654 B
ReStructuredText
|
Commands
|
||
|
|
========
|
||
|
|
|
||
|
|
A command is provided in order to dump the documentation in ``json``, ``markdown``,
|
||
|
|
or ``html``.
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
$ php app/console api:doc:dump [--format="..."]
|
||
|
|
|
||
|
|
The ``--format`` option allows to choose the format (default is: ``markdown``).
|
||
|
|
|
||
|
|
For example to generate a static version of your documentation you can use:
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
$ php app/console api:doc:dump --format=html > api.html
|
||
|
|
|
||
|
|
By default, the generated HTML will add the sandbox feature if you didn't
|
||
|
|
disable it in the configuration. If you want to generate a static version of
|
||
|
|
your documentation without sandbox, use the ``--no-sandbox`` option.
|