Generates documentation for your REST API from annotations
Find a file
2024-06-18 12:54:58 +03:00
.github/workflows Symfony 6 compability 2024-06-18 12:54:58 +03:00
Annotation Compability with PHP 8.1 (string functions calling) 2024-01-30 18:39:44 +03:00
Command Symfony 6 compability 2024-06-18 12:54:58 +03:00
Controller 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
DependencyInjection 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
EventListener 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
Extractor 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
Form/Extension Fix deprecations (#8) 2022-10-07 15:32:38 +03:00
Formatter Compability with PHP 8.1 (string functions calling) 2024-01-30 18:39:44 +03:00
Parser Compability with PHP 8.1 (class_exists calling) 2024-01-30 18:31:12 +03:00
Resources 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
Swagger Tests for aliased collections; Swagger formatting for wrapped collections. 2014-09-04 11:19:54 -07:00
Tests Symfony 6 compability 2024-06-18 12:54:58 +03:00
Twig/Extension fix twig 2023-01-09 16:28:18 +03:00
Util Compability with PHP 8.1 (string functions calling) 2024-01-30 18:39:44 +03:00
.gitignore 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
.travis.yml Compatibility with Symfony 4.3 (#1524) 2022-04-26 16:58:48 +03:00
composer.json Symfony 6 compability 2024-06-18 12:54:58 +03:00
CONTRIBUTING.md Add a note about PR desc in CONTRIBUTING file 2013-11-14 12:07:19 +01:00
DataTypes.php cs 2015-03-06 11:19:08 +01: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 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
NelmioApiDocBundle.php ability to change information for types of forms 2020-07-06 14:53:58 +03:00
phpunit.xml.dist 1. Up min PHP version to 8.1 2024-06-18 12:24:32 +03:00
README.md Update the documentation link 2017-05-13 16:53:58 +02:00

NelmioApiDocBundle

Build
Status Total Downloads Latest Stable
Version

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