RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-01 21:06:15 +03:00
Code Issues Projects Releases Wiki Activity
Generates documentation for your REST API from annotations
417 commits 9 branches 28 tags 17 MiB
Find a file
Guilhem N a3800fb29a
Fix CS
2019-04-20 13:21:54 +02:00
Annotation add a way to filter areas on route by annotation 2019-02-05 22:43:18 +01:00
Controller Improve exceptions message (#1502) 2019-04-12 09:35:49 +02:00
DependencyInjection Added name_patterns filter option (#1504) 2019-04-16 17:22:50 +02:00
Describer Improve exceptions message (#1502) 2019-04-12 09:35:49 +02:00
Form/Extension Add implementation of FormTypeExtensionInterface::getExtendedTypes (#1453) 2019-01-25 18:25:46 +01:00
Model Fix alternative names issue 2018-11-04 12:24:45 +01:00
ModelDescriber Allow model describers on jms custom types (#1495) 2019-04-16 12:13:33 +02:00
Resources Added name_patterns filter option (#1504) 2019-04-16 17:22:50 +02:00
RouteDescriber Fix CS 2019-04-20 13:21:54 +02:00
Routing Added name_patterns filter option (#1504) 2019-04-16 17:22:50 +02:00
SwaggerPhp Support `@Model` in in-object annotations 2018-03-22 19:14:01 +01:00
Tests Added name_patterns filter option (#1504) 2019-04-16 17:22:50 +02:00
Util add a way to filter areas on route by annotation 2019-02-05 22:43:18 +01:00
.gitignore Fix the tests 2017-03-15 13:38:23 +01:00
.php_cs.dist Allow implicit operations with SwaggerPhp annotations 2017-01-08 12:12:43 +01:00
.styleci.yml Add areas support (#1169) 2018-01-05 13:08:02 +01:00
.travis.yml test low deps on 7.2 2019-01-26 20:55:52 +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 Bump Phpunit Bridge (#1499) 2019-04-10 21:44:40 +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 Update travis config (#1117) 2017-11-27 14:40:22 +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

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.