mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-04-01 21:06:15 +03:00
Generates documentation for your REST API from annotations
2c890ff93b
https://github.com/nelmio/NelmioApiDocBundle/runs/3031148906?check_suite_focus=true#step:7:106 Error: Call to undefined method Nelmio\ApiDocBundle\Tests\Render\Html\GetNelmioAssetTest::getContainer() https://symfony.com/blog/new-in-symfony-4-1-simpler-service-testing In practice, tests based on WebTestCase and KernelTestCase now access to a special container via the static::$container property that allows fetching non-removed private services: https://github.com/symfony/symfony/blob/5.3/CHANGELOG-5.3.md#changelog-for-53x feature #40366 [FrameworkBundle] Add KernelTestCase::getContainer() (Nyholm) static $container @deprecated since Symfony 5.3, use static::getContainer() instead |
||
|---|---|---|
| .github/workflows | ||
| Annotation | ||
| Command | ||
| Controller | ||
| DependencyInjection | ||
| Describer | ||
| Exception | ||
| Form/Extension | ||
| Model | ||
| ModelDescriber | ||
| OpenApiPhp | ||
| PropertyDescriber | ||
| Render | ||
| Resources | ||
| RouteDescriber | ||
| Routing | ||
| Tests | ||
| Util | ||
| .gitattributes | ||
| .gitignore | ||
| .php_cs.dist | ||
| .styleci.yml | ||
| .symfony.bundle.yaml | ||
| ApiDocGenerator.php | ||
| CHANGELOG.md | ||
| composer.json | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| NelmioApiDocBundle.php | ||
| phpunit | ||
| phpunit.bat | ||
| phpunit.xml.dist | ||
| README.md | ||
| update-js.sh | ||
| UPGRADE-3.0.md | ||
| UPGRADE-4.0.md | ||
NelmioApiDocBundle
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
Migrate from 3.x to 4.0
To migrate from 3.x to 4.0, follow our guide.
Version 4.0 brings OpenAPI 3.0 support. If you want to stick to Swagger 2.0, you should use the version 3 of this bundle.
Migrate from 2.x to 3.0
To migrate from 2.x to 3.0, follow our guide.
Installation
Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:
composer require nelmio/api-doc-bundle
Documentation
Read the documentation on symfony.com
Contributing
See CONTRIBUTING file.
Running the Tests
Install the Composer dependencies:
git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update
Then run the test suite:
./phpunit
License
This bundle is released under the MIT license.