oro / api-doc-bundle
Fork of nelmio/NelmioApiDocBundle to make 2.x version compatible with Symfony 5
Installs: 1 919
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 833
Type:symfony-bundle
Requires
- php: ~8.0
- michelf/php-markdown: ~1.9
- symfony/console: ~4.4|~5.3|~6.3
- symfony/framework-bundle: ~4.4|~5.3|~6.3
- symfony/twig-bundle: ~4.4|~5.3|~6.3
Suggests
- dunglas/api-bundle: For making use of resources definitions of DunglasApiBundle.
- friendsofsymfony/rest-bundle: For making use of REST information in the doc.
- jms/serializer: For making use of serializer information in the doc.
- symfony/form: For using form definitions as input.
- symfony/validator: For making use of validator information in the doc.
Conflicts
- jms/serializer: <0.12
- jms/serializer-bundle: <0.11
- twig/twig: <1.12
This package is auto-updated.
Last update: 2024-10-30 14:26:54 UTC
README
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
Documentation
Read the documentation on symfony.com
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