Skip to content
This repository

Generates documentation for your REST API from annotations

Merge pull request #363 from cedriclombardot/fix-model-type

Fix parse of input forms with options required
latest commit 1c553e93ec
William Durand willdurand authored April 23, 2014
Octocat-spinner-32 Annotation Fix an properly document https option February 06, 2014
Octocat-spinner-32 Command Fix DumpCommand to generate html with/out sandbox December 06, 2013
Octocat-spinner-32 Controller Fixed rendering issue when used with FOSRestBundle and configured to not August 23, 2012
Octocat-spinner-32 DependencyInjection Added exclude_envs to ApiDoc annotation to exclude the documentation … January 20, 2014
Octocat-spinner-32 EventListener make form and validation extractors optional October 28, 2013
Octocat-spinner-32 Extractor Fix HTTPS detection January 20, 2014
Octocat-spinner-32 Form Fixed BC Break from master (commit symfony/symfony@d072f35 ) July 23, 2012
Octocat-spinner-32 Formatter Fix undefined index in AbstractFormatter December 16, 2013
Octocat-spinner-32 Parser Fix parse of input forms with options required April 11, 2014
Octocat-spinner-32 Resources Added a missing 'is'. March 28, 2014
Octocat-spinner-32 Tests Added PHP 5.6 and HHVM to Travis. March 03, 2014
Octocat-spinner-32 Twig Replace deprecated fork of dflydev's mardown library with the origina… February 19, 2014
Octocat-spinner-32 Util abstracted docblock comment extraction, implemented in JmsMetadataPar… August 31, 2012
Octocat-spinner-32 .gitignore Removed IntelliJ stuff from gitignore November 26, 2012
Octocat-spinner-32 .travis.yml Added PHP 5.6 and HHVM to Travis. March 03, 2014
Octocat-spinner-32 CONTRIBUTING.md Add a note about PR desc in CONTRIBUTING file November 14, 2013
Octocat-spinner-32 NelmioApiDocBundle.php make form and validation extractors optional October 28, 2013
Octocat-spinner-32 README.md Typo fix November 15, 2013
Octocat-spinner-32 composer.json Replace deprecated fork of dflydev's mardown library with the origina… February 19, 2014
Octocat-spinner-32 phpunit.xml.dist Ignore vendor in code coverage April 13, 2012
README.md

NelmioApiDocBundle

Build
Status

The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.

Important: This bundle is developed in sync with symfony's repository. For Symfony 2.0.x, you need to use the 1.* version of the bundle.

Documentation

For documentation, see:

Resources/doc/

Read the documentation

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dev dependencies:

php composer.phar install --dev

Then, run the test suite using PHPUnit:

phpunit

Credits

The design is heavily inspired by the swagger-ui project. Some icons from the Glyphicons library are used to render the documentation.

License

This bundle is released under the MIT license. See the complete license in the bundle:

Resources/meta/LICENSE
Something went wrong with that request. Please try again.