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
498 commits 9 branches 28 tags 17 MiB
Find a file
pratyam fe39acd6a8
Bugfix/remove pattern from property expression message error (#1670) 
* remove pattern added from the Expression Violation message.

This string confuses the API client showing a violation message instead of having a Regex. Any informatory message for the client should be placed in "description"

* fix tests

* fix typo
2020-07-04 16:27:40 +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 Merge pull request #1619 from katin-dev/fix_preloader 2020-05-01 21:30:45 +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 Bugfix/remove pattern from property expression message error (#1670) 2020-07-04 16:27:40 +02:00
PropertyDescriber Exception message fix for array properties 2020-04-16 14:24:25 +03:00
Resources Add @SerializedName support (#1636) 2020-05-30 18:08:25 +02:00
RouteDescriber Merge pull request #1552 from cyberemissary/duplicate-param-cleanup 2020-03-14 11:41:27 +01:00
Routing Added name_patterns filter option (#1504) 2019-04-16 17:22:50 +02:00
SwaggerPhp Fix typos 2020-04-21 23:47:33 +02:00
Tests Bugfix/remove pattern from property expression message error (#1670) 2020-07-04 16:27:40 +02: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 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 Bugfix/remove pattern from property expression message error (#1670) 2020-07-04 16:27:40 +02:00
composer.json Add FOSRestBundle 3.x support (#1637) 2020-05-31 17:47:18 +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 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.