NelmioApiDocBundle/Resources/doc/customization.rst

Customization
=============

The look and feel of the Swagger UI can be customized.

Overwrite Twig Template
-----------------------

If you want to customize parts of the template, you can create your own Twig template.
This allows to change Swagger UI configuration, page title, page header, add additional or replace existing styles or scripts.

Take a look at the Twig documentation `how to extend templates <https://twig.symfony.com/doc/2.x/tags/extends.html>`_.

The following example will add additional scripts and a custom style to the template.
Just create a file ``templates/bundles/NelmioApiDocBundle/SwaggerUi/index.html.twig``.

.. code-block:: twig

    {# templates/bundles/NelmioApiDocBundle/SwaggerUi/index.html.twig #}

    {#
        To avoid a "reached nested level" error an exclamation mark `!` has to be added
        See https://symfony.com/blog/new-in-symfony-3-4-improved-the-overriding-of-templates
    #}
    {% extends '@!NelmioApiDoc/SwaggerUi/index.html.twig' %}

    {#
        Change swagger UI configuration
        All parameters are explained on Swagger UI website:
        https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/
    #}
    {% block swagger_initialization %}
        <script type="text/javascript">
            window.onload = loadSwaggerUI({
                defaultModelsExpandDepth: -1,
                deepLinking: true,
            });
        </script>
    {% endblock %}

    {# Import your own stylesheet #}
    {% block stylesheets %}
        {{ parent() }}
        <link rel="stylesheet" href="{{ asset('css/custom-swagger-styles.css') }}">
    {% endblock stylesheets %}

    {# Import your own script #}
    {% block javascripts %}
        {{ parent() }}
        <script type="text/javascript" src="{{ asset('js/custom-request-signer.js') }}"></script>
    {% endblock javascripts %}

You can have a look at the `original template <https://github.com/nelmio/NelmioApiDocBundle/blob/master/Resources/views/SwaggerUi/index.html.twig>`_, in ``/Resources/views/SwaggerUi/index.html.twig``, to see which blocks can be overridden.