NelmioApiDocBundle

See https://github.com/nelmio/NelmioApiDocBundle/blob/master/CHANGELOG.md

• forms, JMS metadata, DateTime support
• nicer UI
• bug fixes

See https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-3.0.md to migrate from an application using 2.x.

• fix filters always as query parameters #988
• ensure that boolean fields are submited as boolean values when using json #989

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:

1. Make this bundle "feature-frozen", i.e. only accepting bug fixes, no new features
2. A year later, declaring End Of Life (EOL), i.e. closing issue tracker.

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.

Changelog

• Added: hide Requirement when not set (cf. #502)
• Added : headers support
• Added: enable ApiDocExtractor overriding
• Added: translation to description
• Added: request body and curl command to sandbox
• Fixed: Use OUTPUT_RAW to avoid JS syntax error when dumping HTML API doc (cf. #864)
• Fixed: documentation
• Fixed: allow sending empty file data
• Fixed: allow filter descriptions to be used in conjunction with POST/PUT input descriptions
• Fixed: JSON unicode in templates

IMPORTANT CHANGE

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).

Changelog

• Added: xhrFields: { withCredentials: true } to ajaxOptions to enable browser authentication for cross origin API requests* Fixed: PUT vs PATCH paramters (cf. #565)
• Added: Use the response map in the html view
• Added: textarea type for sandbox
• Fixed: Handle circular references in DunglasApiParser (cf. #678)
• Fixed: Collection Type options - Symfony 2.8 Support
• Fixed: Bug with wrong form parsing when several custom inner types exist
• Fixed: Array to string conversion error on array requirements (cf. #564)
• Fixed: Remove incorrect usage of hasOption()
• Fixed: Array to string conversion error on array requirements

• Fixed: check for deprecated method enterScope() in DumpCommand
• Fixed: avoid "array to string conversion" error

• Fixed: 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.

Special thank to @Ener-Getick! And tank you to all other contributors.

CHANGELOG

• Added: Symfony 3.0 support
• Added: default-value parameter to JsonSerializableParser
• Fixed: FOSRestBundle compatibility
• Fixed: route host with placeholder
• Fixed: tests
• Fixed: empty string is now a valid default parameter value that is successfully merged with other parameters, preventing access of uninitialized array key 'default' Added functional test case for mergeParameters() that covers this issue

• Fixed: @ApiDoc parameters setting will override lower parameter definitions in the hierarchy (#739)

• Fixed: let the js library set the proper Content-type header when sending files in sandbox (#501)
• Fixed: support Symfony 2.8+

The whole documentation has been updated!

• Fixed: restore 5.3 compat (implicit, see commit message: https://github.com/nelmio/NelmioApiDocBundle/commit/09bb83e14955dbb82ff0a2417b936ec406bff85f)
• Fixed: options for forms were not passed through (#736)