mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-02 23:59:26 +03:00
78664ef9ec
* Initial pass for OA3 upgrade * Fix Util Tests * Fix first batch of Unit Tests. Up to Model * Another batch of fixed tests * Update annotations * Convert Model & Property Describers * Update tests, Fix RouteDescribers, FIx additional bugs * Another batch of updates * Another batch of fixed Functional Tests * Fix FunctionalTest tests * Fix Bazinga Tests * FIx FOS Rest * Fix JMS TEsts & describers * Fix all Tests * Fix few stuff from own CR * CS Fixes * CS Fixes 2 * CS Fixes 3 * CS Fixes 4 * Remove collection bug * Updates after first CRs * CS * Drop support for SF3 * Update the docs * Add an upgrade guide * misc doc fixes * Configurable media types * Code Style Fixes * Don't use ::$ref for @Response and @RequestBody * Fix upgrading guide * Fix OA case Co-authored-by: Filip Benčo <filip.benco@websupport.sk> Co-authored-by: Guilhem Niot <guilhem.niot@gmail.com> Co-authored-by: Mantis Development <mantis@users.noreply.github.com>
56 lines
1.7 KiB
Markdown
56 lines
1.7 KiB
Markdown
NelmioApiDocBundle
|
|
==================
|
|
|
|
[](http://travis-ci.org/nelmio/NelmioApiDocBundle)
|
|
[](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 3.x to 4.0
|
|
|
|
[To migrate from 3.x to 4.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-4.0.md)
|
|
|
|
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.](https://github.com/nelmio/NelmioApiDocBundle/blob/master/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/current/bundles/NelmioApiDocBundle/index.html)
|
|
|
|
## Contributing
|
|
|
|
See
|
|
[CONTRIBUTING](https://github.com/nelmio/NelmioApiDocBundle/blob/master/CONTRIBUTING.md)
|
|
file.
|
|
|
|
## Running the Tests
|
|
|
|
Install the [Composer](http://getcomposer.org/) 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.
|