Generates documentation for your REST API from annotations
PHP HTML CSS
Latest commit e6e4246 Aug 4, 2016 @willdurand willdurand committed on GitHub Merge pull request #890 from Invis1ble/fix-889
Fixed placeholder translations #889
Failed to load latest commit information.
Annotation Merge pull request #811 from InputOutput/allow-input-and-filters Jun 13, 2016
Command Usage of OUTPUT_RAW to avoid javascript syntax error when dumping HTM… Jun 10, 2016
Controller Introduce the concept of 'views' May 16, 2015
DependencyInjection Improve true/false/null default values on configuration Jun 7, 2015
EventListener make form and validation extractors optional Oct 28, 2013
Extractor #502 Hide Requirement when not set Jun 12, 2016
Form/Extension Add symfony 3.0 support Dec 2, 2015
Formatter Use the response map in the html view Jan 26, 2016
Parser Merge pull request #799 from debesha/master Feb 24, 2016
Resources Fixed placeholder translations #889 Jul 29, 2016
Swagger Tests for aliased collections; Swagger formatting for wrapped collect… Sep 4, 2014
Tests Remove a test since #811 changes the behavior Jun 13, 2016
Twig/Extension Change visibility of markdownParser property to protected, to improve… Mar 23, 2016
Util Add symfony 3.0 support Dec 2, 2015
.gitignore Removed IntelliJ stuff from gitignore Nov 26, 2012
.travis.yml Do not fail on Symfony 4.0 deprecation messages Jun 13, 2016
CONTRIBUTING.md Add a note about PR desc in CONTRIBUTING file Nov 14, 2013
DataTypes.php cs Mar 6, 2015
NelmioApiDocBundle.php DunglasJsonLdApiBundle support Mar 20, 2015
README.md Fixed link to documentation Mar 21, 2016
composer.json Prepare 2.13.0 release Jun 13, 2016
phpunit.xml.dist Ignore vendor in code coverage Apr 13, 2012

README.md

NelmioApiDocBundle

Build
Status Total Downloads Latest Stable
Version

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

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