Api Platform conference
Register now
v3.2 NelmioApiDocBundle Integration
API Platform Conference
September 19-20, 2024 | Lille & online

The international conference on the API Platform Framework

Get ready for game-changing announcements for the PHP community!

The API Platform Conference 2024 is happening soon, and it's close to selling out.
API Platform 4, Caddy web server, Xdebug, AI... Enjoy two days of inspiring talks with our friendly community and our amazing speakers.

Only a few tickets left!

# NelmioApiDocBundle Integration

NelmioApiDoc provides an alternative to the native Swagger/Open API support provided by API Platform.

As NelmioApiDocBundle 3+ has built-in support for API Platform, this documentation is only relevant for people using NelmioApiDocBundle between version 2.9 and 3.0.

For new projects, prefer using the built-in Swagger support and/or NelmioApiDoc 3.

Screenshot of API Platform integrated with NelmioApiDocBundle

NelmioApiDocBundle is supported by API Platform since version 2.9.

To enable the NelmioApiDoc integration, copy the following configuration:

# api/config/packages/api_platform.yaml
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.

You can also help us improve the documentation of this page.

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop