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 21 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.
Fix https://github.com/nelmio/NelmioApiDocBundle/issues/2089
Fix https://github.com/nelmio/NelmioApiDocBundle/issues/2089
add support for doctrine/annotations 2.0 by @GuilhemN in https://github.com/nelmio/NelmioApiDocBundle/pull/2074
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.11.0...v4.11.1
Fix deprecation of Context::detect() and copy root context properties everywhere by @GuilhemN in https://github.com/nelmio/NelmioApiDocBundle/pull/205…
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.10.2...v4.11.0
Nothing published for this version
Nothing published for this version
Optionally use model groups for validation
Improve "No describer found" error message
#[PathParameter] attribute support (#1973)Nothing published for this version
Fix Symfony Serializer should not be mandatory
Fix Symfony Serializer should not be mandatory (https://github.com/nelmio/NelmioApiDocBundle/pull/1938)
This release brings support for:
This release brings support for:
zircote/swagger-php annotations, and for the annotations of this bundle itself (@Areas, @Model, @Security, @Operation).Add zircote/swagger-php 4.x support
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Allow @Area on controller classes
@Area on controller classes (https://github.com/nelmio/NelmioApiDocBundle/pull/1528)Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
This new major version brings OpenApi 3.0 support, a huge thank to all our contributors, reviewers, and to people who reported the issues they were fa
This new major version brings OpenApi 3.0 support, a huge thank to all our contributors, reviewers, and to people who reported the issues they were facing!
Please see the upgrading guide https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-4.0.md), I hope you'll enjoy this new version :)
This version adds @SerializedName annotation support, FOSRestBundle 3.x support, it also leverages the oneOf feature to support compound types such as
This version adds @SerializedName annotation support, FOSRestBundle 3.x support, it also leverages the oneOf feature to support compound types such as MyType|MyOtherType.
It also fixes several bugs from the first beta (see https://github.com/nelmio/NelmioApiDocBundle/compare/v4.0.0-BETA1...v4.0.0-BETA2).
Please try it out and give us your feedback!
This new major version brings OpenApi 3.0 support thanks to an incredible team work (see https://github.com/nelmio/NelmioApiDocBundle/pull/1623).
This new major version brings OpenApi 3.0 support thanks to an incredible team work (see https://github.com/nelmio/NelmioApiDocBundle/pull/1623).
Please give it a try (see the upgrading guide https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-4.0.md) and give us your feedback!
Nothing published for this version
Add the possibility to document only routes with a swagger annotation
Add the possibility to document only routes with a swagger annotation (https://github.com/nelmio/NelmioApiDocBundle/pull/1868)
Nothing published for this version
Add support for php 8 constraint attributes
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Fix errors when using virtual setters/getters with JMS
Includes a few fixes:
allowNull when using Assert\NotBlank (https://github.com/nelmio/NelmioApiDocBundle/pull/1711)@internal tagAdded @SerializedName annotation and name converters support when using Symfony >= 4.2.
@SerializedName annotation and name converters support when using Symfony >= 4.2.@SWG annotations support at methods level in models@SerializedName annotation support and name converters when using Symfony >= 4.2.@SWG annotations support at methods level in modelsNothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Usage of Google Fonts was removed. System fonts serif / sans will be used instead. This can lead to a different look on different operating systems. Y
Usage of Google Fonts was removed. System fonts serif / sans will be used instead.
This can lead to a different look on different operating systems.
You can re-add Google Fonts again manually by overriding the template.
The Twig template for the Swagger UI now contains blocks to make it easier to overwrite certain parts. See the official documentation how to do this.
Nothing published for this version
See https://github.com/nelmio/NelmioApiDocBundle/blob/master/CHANGELOG.md
See https://github.com/nelmio/NelmioApiDocBundle/blob/master/CHANGELOG.md
Add a documentation form extension. Use the documentation option to define how a form field is documented.
Allow references to config definitions in controllers.
Using @Model implicitly in @SWG\Schema, @SWG\Items and @SWG\Property is deprecated. Use ref=@Model() instead.
Before:
/**
* This was considered as an array of models.
*
* @SWG\Property(@Model(type=FooClass::class))
*/
After:
/**
* For an individual object:
* @SWG\Property(ref=@Model(type=FooClass::class))
*
* For an array:
* @SWG\Property(type="array", @SWG\Items(ref=@Model(type=FooClass::class)))
*/
Config
nelmio_api_doc.areas added support to filter by host patterns.
nelmio_api_doc:
areas: [ host_patterns: [ ^api\. ] ]
Added dependency for "symfony/options-resolver:^3.4.4|^4.0"
Added Symfony Validator constraints support
Symfony Forms
JMS Serializer
int (alias for integer)SwaggerPHP
enum and default properties from SwaggerPHP annotation@Security annotationsConfig
nelmio_api_doc.routes has been replaced by nelmio_api_doc.areas. Please update your config accordingly.
Before:
nelmio_api_doc:
routes: [ path_patterns: [ /api ] ]
After:
nelmio_api_doc:
areas: [ path_patterns: [ /api ] ]
Large refactoring introducing zircote/swagger-php for swagger annotations.
Large refactoring introducing zircote/swagger-php for swagger annotations.
See UPGRADE-3.0.md for upgrading instructions.
forms, JMS metadata, DateTime support
Nothing published for this version
Nothing published for this version
See https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-3.0.md to migrate from an application using 2.x.
See https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-3.0.md to migrate from an application using 2.x.
Nothing published for this version
Nothing published for this version
Nothing published for this version
fix filters always as query parameters #988
Nothing published for this version
Here is a new version of this bundle with a few improvements and bug fixes. As I asked on Twitter, I am thinking about slowly deprecating this bundle.…
Hi!
Here is a new version of this bundle with a few improvements and bug fixes. As I asked on Twitter, I am thinking about slowly deprecating this bundle. That would mean:
When I started this project, we needed a simple yet efficient and fast way to document our APIs at Nelmio. Nowadays, this project has become the bundle for documenting APIs in the Symfony world, with more than 3.3 million installs (June 2016). Four years ago, the Swagger project was something we considered a bit but it was not even version 1.0, and we did not choose it for some reasons I cannot even remember. Anyway, now there is Swagger version 2, which is really powerful and nice (and almost a standard).
This bundle does not support Swagger v2 unfortunately, and users started to hack around this bundle and Swagger: https://blog.liip.ch/archive/2016/05/11/convert-nelmioapidocbundle-to-swagger-php.html. I believe it is a wise decision.
I already did a "call for maintainers" a while ago, but it is rather complicated to get someone involved in a project for a reasonable period of time (which I perfectly understand), and I have not been contacted by anyone. On the other hand, I don't personally use this bundle, hence I cannot maintain it anymore.
That is why I am thinking about deprecating this bundle, and encouraging more recent and robust alternatives. Feel free to get in touch with me (or by email using the address on my profile).
Thanks, William.
ApiDocExtractor overridingcurl command to sandboxOUTPUT_RAW to avoid JS syntax error when dumping HTML API doc (cf. #864)The bundle declares a conflict with symfony/symfony ~2.7.8 (that means, Symfony 2.7.8, 2.7.9, etc. until 2.8.0).
The bundle declares a conflict with symfony/symfony ~2.7.8 (that means, Symfony 2.7.8, 2.7.9, etc. until 2.8.0).
xhrFields: { withCredentials: true } to ajaxOptions to enable browser authentication for cross origin API requests* Fixed: PUT vs PATCH paramters (cf. #565)DunglasApiParser (cf. #678)hasOption()Fixed: check for deprecated method enterScope() in DumpCommand
enterScope() in DumpCommandFixed: a deprecation noticed that was still displayed
Hi! This release contains a few bug fixes, but the main improvement is the support of Symfony 3.0.
Hi! This release contains a few bug fixes, but the main improvement is the support of Symfony 3.0.
Special thank to @Ener-Getick! And tank you to all other contributors.
JsonSerializableParsermergeParameters() that covers this issueOne column per quarter.