Generates documentation for your REST API from annotations
Find a file
2024-10-10 23:14:28 +03:00
.github/workflows Add php-cs-fixer 2024-10-01 15:53:49 +03:00
Attribute Migrate annotation ApiDoc to attribute 2024-10-01 23:00:23 +03:00
Command Migrate annotation ApiDoc to attribute 2024-10-01 23:00:23 +03:00
Controller Migrate annotation ApiDoc to attribute 2024-10-01 23:00:23 +03:00
DependencyInjection Migrate annotation ApiDoc to attribute 2024-10-01 23:00:23 +03:00
EventListener Fix code by php-cs-fixer 2024-10-01 15:54:04 +03:00
Extractor Migrate annotation ApiDoc to attribute 2024-10-01 23:00:23 +03:00
Form/Extension Fix code by php-cs-fixer 2024-10-01 15:54:04 +03:00
Formatter Migrate annotation ApiDoc to attribute 2024-10-01 23:00:23 +03:00
Parser remove the support of duglas 2024-10-01 16:39:44 +03:00
Resources Migrate annotation ApiDoc to attribute 2024-10-01 23:00:23 +03:00
Swagger Fix code by php-cs-fixer 2024-10-01 15:54:04 +03:00
Tests Migrate annotation ApiDoc to attribute 2024-10-01 23:00:23 +03:00
Twig/Extension fix twig deprecates 2024-10-10 23:07:49 +03:00
Util Fix code by php-cs-fixer 2024-10-01 15:54:04 +03:00
.gitignore 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
.php-cs-fixer.dist.php Add php-cs-fixer 2024-10-01 15:53:49 +03:00
composer.json Remove the support of fos-rest 2024-10-01 17:18:04 +03:00
CONTRIBUTING.md Add a note about PR desc in CONTRIBUTING file 2013-11-14 12:07:19 +01:00
DataTypes.php Fix code by php-cs-fixer 2024-10-01 15:54:04 +03:00
docker-compose.yml 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
Dockerfile 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
Makefile Add php-cs-fixer 2024-10-01 15:53:49 +03:00
NelmioApiDocBundle.php remove the support of duglas 2024-10-01 16:39:44 +03:00
phpunit.xml.dist 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
README.md Remove dunglasapibundle support 2024-10-01 17:26:49 +03:00

NelmioApiDocBundle

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