Generates documentation for your REST API from annotations
Clone or download
Latest commit 7848e00 Nov 12, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Annotation Added support for `@Security` annotations (#1201) Jan 25, 2018
Controller Add areas support (#1169) Jan 5, 2018
DependencyInjection Merge pull request #1404 from bifidokk/area-docs Oct 6, 2018
Describer Add ability to use response objects which defined in configuration Oct 2, 2018
Form/Extension Add a documentation form extension (#1234) Feb 19, 2018
Model Fix alternative names issue Nov 4, 2018
ModelDescriber Fix alternative names issue Nov 4, 2018
Resources faq.rst: enhance readability in symfony.com docs (#1420) Oct 31, 2018
RouteDescriber Respect the spec in the FosRestDescriber (#1390) Aug 29, 2018
Routing Remove documentation from route builder Oct 5, 2018
SwaggerPhp Support ``@Model`` in in-object annotations Mar 22, 2018
Tests fix codestyle errors Nov 11, 2018
Util Apply fixes from StyleCI Dec 22, 2017
.gitignore Fix the tests Mar 15, 2017
.php_cs.dist Allow implicit operations with SwaggerPhp annotations Jan 8, 2017
.styleci.yml Add areas support (#1169) Jan 5, 2018
.travis.yml Run CI pipeline with PHP 7.2 May 28, 2018
ApiDocGenerator.php Implement alternative naming system via configuration (#1312) Jun 10, 2018
CHANGELOG.md Customizable template and remove Google Fonts (#1357) Jul 16, 2018
CONTRIBUTING.md Document the bundle May 13, 2017
LICENSE Change the vendor to "Nelmio" Dec 29, 2016
NelmioApiDocBundle.php Add areas support (#1169) Jan 5, 2018
README.md Fixes Jan 4, 2018
UPGRADE-3.0.md Merge pull request #1264 from adeelnawaz/master Mar 24, 2018
composer.json [JMSModelDescriber] Allow to use free form objects from JMS serializa… Aug 21, 2018
phpunit Update PHPUnit to 6.5 and allow newer version of PHPUnit Bridge May 28, 2018
phpunit.xml.dist Update travis config (#1117) Nov 27, 2017
update-js.sh Include map files Jun 22, 2017

README.md

NelmioApiDocBundle

Build Status Total Downloads Latest Stable Version

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

Migrate from 2.x to 3.0

To migrate from 2.x to 3.0, just follow our guide.

Installation

Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:

composer require nelmio/api-doc-bundle

Documentation

Read the documentation on symfony.com

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dependencies:

git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update

Then run the test suite:

./phpunit

License

This bundle is released under the MIT license.