mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-09 02:59:27 +03:00
df1c85ae5e
The tests against specific Symfony versions are now running only for a single PHP version to limit the number of jobs in the build matrix. They are also installing the full Symfony repo to be sure that all components are actually at the specified version without the need to require each of them explicitly.
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