NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
Packagist, #615 most downloaded on Packagist
Generates documentation for your REST API from attributes
Latest stable
v5.13.2
Last release 17 days ago
30 Oct 2026
Ships fairly regularly
a new release about every 3 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
14 years old
210 releases · first in 2012
Drag across the ruler to compare, or tap a release to open it.
feat: migration path for with_annotation to with_attribute by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2430
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.35.2...v4.36.0
with_annotation has been deprecated in favor of with_attributenelmio_api_doc:
areas:
path_patterns:
- ^/api/foo
- with_annotation: true
+ with_attribute: true
fix: deprecation warning for usage of "tagged" by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2429
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.35.1...v4.35.2
fix: mark PropertyDescribers with @final by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2425
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.35.0...v4.35.1
feat(#2212): support type info component by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2349
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.34.1...v4.35.0
nelmio_api_doc:
type_info: true
docs: fix examples for RequestBody by @xavierleune in https://github.com/nelmio/NelmioApiDocBundle/pull/2415
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.34.0...v4.34.1
chore: bump symfony 7.x minimum to 7.1 by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2419
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.33.6...v4.34.0
Remove deprecate use of tagged argument in favor of tagged_iterator by @Seldaek in https://github.com/nelmio/NelmioApiDocBundle/pull/2410
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.33.5...v4.33.6
refactor: add $context to PropertyDescriberInterface::supports() by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2393
@PHP84Migration ruleset by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2398Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.33.4...v4.33.5
$context to PropertyDescriberInterface::supports()refactor: deprecate options possibly being null by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2387
options possibly being null by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2387Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.33.3...v4.33.4
null type from $options in Nelmio\ApiDocBundle\Attribute\Model::__construct(). Pass an empty array ([]) instead.null type from $options in NNelmio\ApiDocBundle\Attribute\Model::__construct(). Pass an empty array ([]) instead.fix: incorrect script destination by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2380
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.33.2...v4.33.3
5.18.1 to 5.18.22.2.0fix: incorrect directory used for updated swagger-ui by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2379
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.33.1...v4.33.2
4.33.2refactor: remove deprecation & thrown exception & constructor defaults by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2375
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.33.0...v4.33.1
5.18.1#[OA\Property] being overwrittendocs: improve areas attribute rendering by @qkdreyer in https://github.com/nelmio/NelmioApiDocBundle/pull/2371
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.32.3...v4.33.0
ci: [4.x] codecov by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2366
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.32.2...v4.32.3
Nelmio\ApiDocBundle\Annotation namespace in favor of Nelmio\ApiDocBundle\Attribute namespace in preparation for 5.x. Consider upgrading to the new attribute syntax.- use Nelmio\ApiDocBundle\Annotation\Areas;
- use Nelmio\ApiDocBundle\Annotation\Model;
- use Nelmio\ApiDocBundle\Annotation\Operation;
- use Nelmio\ApiDocBundle\Annotation\Security;
+ use Nelmio\ApiDocBundle\Attribute\Areas;
+ use Nelmio\ApiDocBundle\Attribute\Model;
+ use Nelmio\ApiDocBundle\Attribute\Operation;
+ use Nelmio\ApiDocBundle\Attribute\Security;
fix: add missing trigger_deprecation calls to deprecated classes, methods by @DominicLuidold in https://github.com/nelmio/NelmioApiDocBundle/pull/2265
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.32.1...v4.32.2
chore: fix ci by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2352
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.32.0...v4.32.1
fix: pass through serializationContext into models where possible by @herndlm in https://github.com/nelmio/NelmioApiDocBundle/pull/2344
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.31.0...v4.32.0
options and serializationContext via nelmio_api_doc.models.names.serializationContext not being applied to nested models.chore: fix ci by @herndlm in https://github.com/nelmio/NelmioApiDocBundle/pull/2343
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.30.0...v4.31.0
useJms in the serializationContext.#[OA\Response(response: 200, content: new Model(type: UserDto::class, serializationContext: ["useJms" => false]))]
feat: create top level Tag from Tag annotations by @noemi-salaun in https://github.com/nelmio/NelmioApiDocBundle/pull/2334
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.29.3...v4.30.0
fix(#2336): keep original index key by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2337
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.29.2...v4.29.3
fix(SymfonyConstraintAnnotationReader): disallow null if NotNull attribute is present by @jeremyVignelles in https://github.com/nelmio/NelmioApiDocBun
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.29.1...v4.29.2
docs: add documentation on how to use assets_mode by @lacpandore in https://github.com/nelmio/NelmioApiDocBundle/pull/2318
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.29.0...v4.29.1
fix(#2291): symfony 7.1 - deprecation Symfony\Component\HttpKernel\DependencyInjection\Extension by @mamchyts in https://github.com/nelmio/NelmioApiDo…
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.28.0...v4.29.0
feat: add arrays of enums and enum callbacks for query params by @indexxd in https://github.com/nelmio/NelmioApiDocBundle/pull/2096
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.27.1...v4.28.0
fix(#2300): fix missing context param UuidPropertyDescriber::describe() by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2302
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.27.0...v4.27.1
feat: apply rule ReturnTypeFromReturnDirectArrayRector from rector by @shakaran in https://github.com/nelmio/NelmioApiDocBundle/pull/2292
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.26.2...v4.27.0
feat: apply rule TypedPropertyFromStrictConstructor from rector by @shakaran in https://github.com/nelmio/NelmioApiDocBundle/pull/2283
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.26.1...v4.26.2
fix: Unknown Constraint class when not using symfony/validator by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2276
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.26.0...v4.26.1
feat: Add ability to configure UI through configuration by @HypeMC in https://github.com/nelmio/NelmioApiDocBundle/pull/2251
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/4.25.3...v4.26.0
nelmio_api_doc:
html_config:
assets_mode: bundle
redocly_config:
expandResponses: '200,201'
hideDownloadButton: true
swagger_ui_config:
deepLinking: true
[CI] Install friendsofsymfony/rest-bundle with Symfony 7 by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2257
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/4.25.2...4.25.3
DocumentationExtension::getExtendedType() has been deprecated in favor of DocumentationExtension::getExtendedTypes() to align with the deprecation introduced with symfony/symfony version 4.2.Bump actions/cache from 3 to 4 by @dependabot in https://github.com/nelmio/NelmioApiDocBundle/pull/2255
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.25.1...4.25.2
Install & run PHP-CS-Fixer by @DominicLuidold in https://github.com/nelmio/NelmioApiDocBundle/pull/2250
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.25.0...v4.25.1
Added support for JMS @Discriminator annotation/attribute ```php
#[\JMS\Serializer\Annotation\Discriminator(field: 'type', map: ['car' => Car::class, 'plane' => Plane::class])]
abstract class Vehicle { }
class Car extends Vehicle { }
class Plane extends Vehicle { }
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.24.1...v4.25.0
Added conflict for swagger-php 4.8.7, see issue https://github.com/zircote/swagger-php/issues/1562
Added support for some integer ranges (https://phpstan.org/writing-php-code/phpdoc-types#integer-ranges). Annotations attached to integer properties l
Added support for some integer ranges (https://phpstan.org/writing-php-code/phpdoc-types#integer-ranges). Annotations attached to integer properties like:
/**
* @var int<6, 11>
* @var int<min, 11>
* @var int<6, max>
* @var positive-int
* @var negative-int
*/
will be interpreted as appropriate minimum and maximum properties in the generated OpenAPI specification.
Dropped support for PHP 7.2 and PHP 7.3. PHP 7.4 is the minimum required version now.
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.23.1...v4.24.0
fix: use iterable check instead of array by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2239
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.23.0...v4.23.1
Cache configuration option nelmio_api_doc.cache.item_id now automatically gets the area appended. `yml nelmio_api_doc: cache: pool: app.cache item_id:
nelmio_api_doc.cache.item_id now automatically gets the area appended.nelmio_api_doc:
cache:
pool: app.cache
item_id: nelmio_api_doc.docs
areas:
default:
...
area1:
...
Result in cache keys: nelmio_api_doc.docs.default & nelmio_api_doc.docs.area1 to be used respectively.nelmio_api_doc:
areas:
default: # Manual cache configuration
cache:
pool: app.cache
item_id: nelmio_api_doc.docs.default
...
area1:
cache:
pool: app.cache
item_id: nelmio_api_doc.docs.area1
...
Non-configured options will be inherited from nelmio_api_doc.cache.x-*) from configuration not being outputted in the generated specification.nelmio_api_doc:
documentation:
info:
title: 'My API'
description: 'My API description'
x-foo: 'bar'
Now results in JSON specification:{
...
"info": {
"title": "API",
"version": "1.0",
"x-foo": "bar"
},
...
}
oneOf instead of allOf.Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.22.1...v4.23.0
update .gitattributes for new directory structure by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2229
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.22.0...v4.22.1
Updated bundle directory structure to recommended file structure as described in https://symfony.com/doc/7.0/bundles/best_practices.html.
Updated bundle directory structure to recommended file structure as described in https://symfony.com/doc/7.0/bundles/best_practices.html.
It might be necessary to reinstall the assets:
bin/console assets:install
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.21.0...v4.22.0
Updated bundle directory structure to recommended file structure as described in https://symfony.com/doc/7.0/bundles/best_practices.html.
It might be necessary to reinstall the assets:
bin/console assets:install
If your codebase mentions a file or directory by path then an update to this path is necessary. For example to following configuration:
doc-api:
resource: "@NelmioApiDocBundle/Resources/config/routing/swaggerui.xml"
prefix: /api/doc
Becomes:
doc-api:
resource: "@NelmioApiDocBundle/config/routing/swaggerui.xml"
prefix: /api/doc
Added bundle configuration options cache.pool and cache.item_id.
cache.pool and cache.item_id.cache_pool option in configuration by @Brajk19 in https://github.com/nelmio/NelmioApiDocBundle/pull/2225Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.20.0...v4.21.0
nelmio_api_doc.cache.pool and nelmio_api_doc.cache.item_id.nelmio_api_doc:
cache:
pool: app.cache
item_id: nelmio_api_doc.docs
Added Redocly as an alternative to Swagger UI. https://github.com/Redocly/redoc.
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.19.3...v4.20.0
fix-2209: Multiple @OA\MediaType() warning with MapRequestPayload by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2213
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.19.2...v4.19.3
fix: move to processor to correct dir by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2204
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.19.1...v4.19.2
fix-2202: Correctly describe array parameter by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2203
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.19.0...v4.19.1
Support CSRF protection token of Symfony's form component by @stollr in https://github.com/nelmio/NelmioApiDocBundle/pull/2132
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.18.3...v4.19.0
use hash to determine unique types by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2201
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.18.2...v4.18.3
fix describing multiple map query string attributes by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2195
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.18.1...v4.18.2
fix: attribute validation groups not passed by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2189
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.18.0...v4.18.1
Add Symfony attribute describers by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2112
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.17.1...v4.18.0
fix-2187: Check if schema is available by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2188
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.17.0...v4.17.1
refactor: PropertyDescribers by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2184
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.16.2...v4.17.0
PropertyDescriberInterface::describe() via the $groups parameter is deprecated, the parameter will get removed in a future version. Pass groups via $context['groups'] instead.fix: different context uses same model by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2183
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.16.1...v4.16.2
ci fix for new Article81 property by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2180
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.16.0...v4.16.1
Add jms/serializer enum support by @javer in https://github.com/nelmio/NelmioApiDocBundle/pull/2078
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.15.3...v4.16.0
fix: describe nullable enums with allOf by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2178
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.15.2...v4.15.3
use string instead of constant by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2174
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.15.1...v4.15.2
Fix wrong detection of OA min/max for symfony contraints with datetime strings by @Tobion in https://github.com/nelmio/NelmioApiDocBundle/pull/2148
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.15.0...v4.15.1
Fix enum backing type always 'string' by @DidierLmn in https://github.com/nelmio/NelmioApiDocBundle/pull/2121
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.14.0...v4.15.0
cleanup phpunit related things by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2170
custom processors through tagged services by @Luehrsen in https://github.com/nelmio/NelmioApiDocBundle/pull/2149Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.13.0...v4.14.0
Fix failing phpunit by @DjordyKoert in https://github.com/nelmio/NelmioApiDocBundle/pull/2126
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.12.0...v4.13.0
One column per quarter.