mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-02 23:59:26 +03:00
50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
NelmioApiDocBundle
|
|
==================
|
|
|
|
[](https://github.com/nelmio/NelmioApiDocBundle/actions?query=workflow:CI)
|
|
[](https://packagist.org/packages/nelmio/api-doc-bundle)
|
|
[](https://packagist.org/packages/nelmio/api-doc-bundle)
|
|
|
|
The **NelmioApiDocBundle** bundle allows you to generate a decent documentation
|
|
for your APIs.
|
|
|
|
## Migrate from 2.x to 3.0
|
|
|
|
[To migrate from 2.x to 3.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/3.x/UPGRADE-3.0.md)
|
|
|
|
## 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](https://symfony.com/doc/3.x/bundles/NelmioApiDocBundle/index.html)
|
|
|
|
## Contributing
|
|
|
|
See
|
|
[CONTRIBUTING](https://github.com/nelmio/NelmioApiDocBundle/blob/3.x/CONTRIBUTING.md)
|
|
file.
|
|
|
|
## Running the Tests
|
|
|
|
Install the [Composer](http://getcomposer.org/) dependencies:
|
|
|
|
git clone https://github.com/nelmio/NelmioApiDocBundle.git
|
|
cd NelmioApiDocBundle
|
|
git checkout 3.x
|
|
composer update
|
|
|
|
Then run the test suite:
|
|
|
|
./phpunit
|
|
|
|
## License
|
|
|
|
This bundle is released under the MIT license.
|