mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-02 15:51:48 +03:00
Julius Beckmann
0845377300
Use only JMS/GroupExclusion if groups are there
When no groups are given in the ApiDoc, there should be no GroupExclusion and the Entity should be parsed wihtout exclusions. Otherwise only the "Default" group of the Entity would be parsed, which may not be used. The ApiDoc should not enforce the Entity to be grouped with "Default", to generate a "full-view" of it.
NelmioApiDocBundle
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
Important: This bundle is developed in sync with symfony's
repository.
For Symfony 2.0.x
, you need to use the 1.*
version of the bundle.
Documentation
For documentation, see:
Resources/doc/
Contributing
See CONTRIBUTING file.
Running the Tests
Install the Composer dev
dependencies:
php composer.phar install --dev
Then, run the test suite using PHPUnit:
phpunit
Credits
The design is heavily inspired by the swagger-ui project. Some icons from the Glyphicons library are used to render the documentation.
License
This bundle is released under the MIT license. See the complete license in the bundle:
Resources/meta/LICENSE
Description
Languages
PHP
86.4%
Twig
11%
CSS
2.5%