RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-01 21:06:15 +03:00
Code Issues Projects Releases Wiki Activity
Generates documentation for your REST API from annotations
552 commits 9 branches 28 tags 17 MiB
Find a file
Guilhem Niot 865527b85b Merge branch '3.x'
2020-09-09 08:55:20 +02:00
Annotation OpenApi 3 Support (#1623) 2020-05-28 13:19:11 +02:00
Command Fix ServerVariable management (#1694) 2020-08-11 16:44:05 +02:00
Controller Remove deprecated features (#1640) 2020-05-31 18:18:29 +02:00
DependencyInjection Move the OpenApi processing to ApiDocGenerator (#1671) 2020-07-06 19:50:34 +02:00
Describer Merge branch '3.x' 2020-08-06 10:29:17 +02:00
Form/Extension Allow Symfony 5 2019-11-29 13:59:27 +01:00
Model Add support for compound properties (#1651) 2020-06-16 13:11:53 +02:00
ModelDescriber Merge branch '3.x' 2020-09-09 08:55:20 +02:00
OpenApiPhp Fix ServerVariable management (#1694) 2020-08-11 16:44:05 +02:00
PropertyDescriber Fix nullable array properties (#1697) 2020-08-06 10:22:59 +02:00
Resources Update @OA\Parameter usage example (#1706) 2020-08-26 22:30:16 +02:00
RouteDescriber Fix incorrect media types (#1712) 2020-09-01 16:42:55 +02:00
Routing Apply StyleCI fixes 2020-08-06 10:26:59 +02:00
Tests Merge branch '3.x' 2020-09-09 08:55:20 +02:00
Util Supports reflection for routes configured in PHP files. (#1701) 2020-08-11 16:46:05 +02:00
.gitignore Fix build travis 2019-11-20 12:15:00 +01:00
.php_cs.dist Fix build travis 2019-11-20 12:15:00 +01:00
.styleci.yml Update StyleCI config 2020-08-06 10:25:35 +02:00
.travis.yml Merge branch '3.x' 2020-05-31 17:54:32 +02:00
ApiDocGenerator.php Disable the OperationId processor (#1685) 2020-07-24 08:37:58 +02:00
CHANGELOG.md Release version 3.7 2020-08-12 11:06:17 +02:00
composer.json Merge branch '3.x' 2020-07-24 17:00:10 +02:00
CONTRIBUTING.md Added name_patterns filter option (#1504) 2019-04-16 17:22:50 +02:00
LICENSE Change the vendor to "Nelmio" 2016-12-29 12:09:26 +01:00
NelmioApiDocBundle.php Add areas support (#1169) 2018-01-05 13:08:02 +01:00
phpunit Fix Declaration must be compatible error with tests (#1638) 2020-05-31 15:16:51 +02:00
phpunit.bat Fix Declaration must be compatible error with tests (#1638) 2020-05-31 15:16:51 +02:00
phpunit.xml.dist Allow Symfony 5 2019-11-29 13:59:27 +01:00
README.md Update the links in the README 2020-07-24 16:58:58 +02:00
update-js.sh Include map files 2017-06-22 21:22:10 +02:00
UPGRADE-3.0.md Add exceptions in the upgrading command to warn about the requirement to run it on 2.x (#1501) 2019-04-11 20:54:16 +02:00
UPGRADE-4.0.md Add support for compound properties (#1651) 2020-06-16 13:11:53 +02:00

README.md

NelmioApiDocBundle

Build Status Total Downloads Latest Stable Version

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.