Skip to content
Generates documentation for your REST API from annotations
PHP CSS HTML Other
Branch: master
Clone or download

Latest commit

GuilhemN Merge pull request #1622 from goetas/jms-inline
Add support for JMS Serializer inline property feature
Latest commit 2a78b42 May 15, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Annotation Merge pull request #1522 from ahilles107/port/options_support_in_model Jun 1, 2019
Controller Allow Twig 3 Nov 21, 2019
DependencyInjection Remove deprecated notice about controller_name_converter Nov 19, 2019
Describer Merge pull request #1619 from katin-dev/fix_preloader May 1, 2020
Form/Extension Allow Symfony 5 Nov 29, 2019
Model Merge pull request #1522 from ahilles107/port/options_support_in_model Jun 1, 2019
ModelDescriber add support for jms serializer inline property feature May 7, 2020
PropertyDescriber Exception message fix for array properties Apr 16, 2020
Resources Upgrade Swagger UI to 3.25.0 Mar 22, 2020
RouteDescriber Merge pull request #1552 from cyberemissary/duplicate-param-cleanup Mar 14, 2020
Routing Added name_patterns filter option (#1504) Apr 16, 2019
SwaggerPhp Fix typos Apr 21, 2020
Tests add support for jms serializer inline property feature May 7, 2020
Util Merge pull request #1556 from maxhelias/reflection-method Nov 21, 2019
.gitignore Fix build travis Nov 20, 2019
.php_cs.dist Fix build travis Nov 20, 2019
.styleci.yml Add areas support (#1169) Jan 5, 2018
.travis.yml Merge pull request #1578 from smoench/remove-fosrest-on-symfony5-test Feb 21, 2020
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 Added name_patterns filter option (#1504) Apr 16, 2019
LICENSE Change the vendor to "Nelmio" Dec 29, 2016
NelmioApiDocBundle.php Add areas support (#1169) Jan 5, 2018
README.md Add exceptions in the upgrading command to warn about the requirement… Apr 11, 2019
UPGRADE-3.0.md Add exceptions in the upgrading command to warn about the requirement… Apr 11, 2019
composer.json Allow "phpdocumentor/reflection-docblock:5.0" Feb 19, 2020
phpunit Update PHPUnit to 6.5 and allow newer version of PHPUnit Bridge May 28, 2018
phpunit.xml.dist Allow Symfony 5 Nov 29, 2019
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, 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.

You can’t perform that action at this time.