mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 23:59:26 +03:00

Go to file

Merge pull request #1591 from nelmio/analysis-e7YKjA

Apply fixes from StyleCI

2020-02-23 17:51:12 +01: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

Use getReflectionMethod instead of getReflactionClassAndMethod

2019-11-21 18:14:59 +01: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 fixes from StyleCI

2020-02-23 16:50:24 +00:00

PropertyDescriber

Revert ModelDescriberAwareInterface

2020-02-18 21:08:48 +01:00

Resources

Update after PR

2020-02-18 20:45:58 +01:00

RouteDescriber

Use FOSRest *Param::$key when defined

2020-02-21 10:42:13 +01:00

Routing

Added name_patterns filter option (#1504 )

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

SwaggerPhp

Merge pull request #1522 from ahilles107/port/options_support_in_model

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

Tests

Use FOSRest *Param::$key when defined

2020-02-21 10:42:13 +01:00

Util

Merge pull request #1556 from maxhelias/reflection-method

2019-11-21 18:18:16 +01: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

Add areas support (#1169 )

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

.travis.yml

Merge pull request #1578 from smoench/remove-fosrest-on-symfony5-test

2020-02-21 10:27:25 +01:00

ApiDocGenerator.php

Implement alternative naming system via configuration (#1312 )

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

CHANGELOG.md

Customizable template and remove Google Fonts (#1357 )

2018-07-16 09:45:18 +02:00

composer.json

Allow "phpdocumentor/reflection-docblock:5.0"

2020-02-19 16:26:38 -03: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

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

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
composer update

Then run the test suite:

./phpunit

License

This bundle is released under the MIT license.