nelmio-api-doc.md

NelmioApiDocBundle Integration

NelmioApiDocBundle (since version 2.9) has built-in support for API Platform. Installing it will give you access to a human-readable documentation and a nice sandbox. It is an alternative to the builtin API Platform documentation.

To enable the NelmioApiDoc integration, copy the following configuration:

# app/config/config.yml

api_platform:
    # ...
    enable_nelmio_api_doc: true

nelmio_api_doc:
    sandbox:
        accept_type:        'application/json'
        body_format:
            formats:        ['json']
            default_format: 'json'
        request_format:
            formats:
                json:       'application/json'

Please note that NelmioApiDocBundle has a sandbox limitation where you cannot pass a JSON array as parameter, so you cannot use it to deserialize nested objects.

Previous chapter: Adding a JWT authentication using LexikJWTAuthenticationBundle

Next chapter: AngularJS Integration