mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00

Go to file

Supports reflection for routes configured in PHP files. (#1701 )

By default the PHP configuration routes returns an array with the controller name and method, since the reflection class was typed for string only this was causing an exception when the user was not using YAML or XML configuration.
This changes removes the string type hint from the method and checks if it's an array or string to do the reflection.

Co-authored-by: Adir Kuhn <adir@123inkt.nl>

2020-08-11 16:46:05 +02:00

Annotation

Merge pull request #1522 from ahilles107/port/options_support_in_model

2019-06-01 15:31:09 +02:00

Controller

Allow Twig 3

2019-11-21 08:53:58 +01:00

DependencyInjection

Remove deprecated notice about controller_name_converter

2019-11-19 17:23:12 +01:00

Describer

Apply StyleCI fixes

2020-08-06 10:26:59 +02:00

Form/Extension

Allow Symfony 5

2019-11-29 13:59:27 +01:00

Model

Merge pull request #1522 from ahilles107/port/options_support_in_model

2019-06-01 15:31:09 +02:00

ModelDescriber

Apply StyleCI fixes

2020-08-06 10:26:59 +02:00

PropertyDescriber

Exception message fix for array properties

2020-04-16 14:24:25 +03:00

Resources

Update the installation command

2020-07-24 16:57:39 +02:00

RouteDescriber

Merge pull request #1552 from cyberemissary/duplicate-param-cleanup

2020-03-14 11:41:27 +01:00

Routing

Apply StyleCI fixes

2020-08-06 10:26:59 +02:00

SwaggerPhp

Fix typos

2020-04-21 23:47:33 +02:00

Tests

Apply StyleCI fixes

2020-08-06 10:26:59 +02:00

Util

Supports reflection for routes configured in PHP files. (#1701 )

2020-08-11 16:46:05 +02:00

.gitignore

Fix build travis

2019-11-20 12:15:00 +01:00

.php_cs.dist

Fix build travis

2019-11-20 12:15:00 +01:00

.styleci.yml

Update StyleCI config

2020-08-06 10:25:35 +02:00

.travis.yml

Add FOSRestBundle 3.x support (#1637 )

2020-05-31 17:47:18 +02:00

ApiDocGenerator.php

Implement alternative naming system via configuration (#1312 )

2018-06-10 09:56:38 +02:00

CHANGELOG.md

Update CHANGELOG.md

2020-07-24 15:45:52 +02:00

composer.json

Excluded tests from classmap (#1521 )

2020-07-24 15:48:12 +02:00

CONTRIBUTING.md

Added name_patterns filter option (#1504 )

2019-04-16 17:22:50 +02:00

LICENSE

Change the vendor to "Nelmio"

2016-12-29 12:09:26 +01:00

NelmioApiDocBundle.php

Add areas support (#1169 )

2018-01-05 13:08:02 +01:00

phpunit

Update PHPUnit to 6.5 and allow newer version of PHPUnit Bridge

2018-05-28 13:58:42 +02:00

phpunit.xml.dist

Allow Symfony 5

2019-11-29 13:59:27 +01:00

README.md

Update the links in the README

2020-07-24 16:58:58 +02:00

update-js.sh

Include map files

2017-06-22 21:22:10 +02:00

UPGRADE-3.0.md

Add exceptions in the upgrading command to warn about the requirement to run it on 2.x (#1501 )

2019-04-11 20:54:16 +02:00

README.md

NelmioApiDocBundle

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
git checkout 3.x
composer update

Then run the test suite:

./phpunit

License

This bundle is released under the MIT license.