mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-02 21:36:14 +03:00

Generates documentation for your REST API from annotations

Find a file

Guilhem Niot 7d9573ddf6 Move the OpenApi processing to ApiDocGenerator (#1671 ) * Move the OpenApi processing to ApiDocGenerator * Temporary fix for https://github.com/zircote/swagger-php/pull/791 * Stop using the ModelRegistry in OpenApiPhpDescriber		2020-07-06 19:50:34 +02:00
Annotation	OpenApi 3 Support (#1623 )	2020-05-28 13:19:11 +02:00
Command	Add dump command to print out swagger JSON. (#1537 ) (#1540 )	2020-05-31 11:39:50 +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	Move the OpenApi processing to ApiDocGenerator (#1671 )	2020-07-06 19:50:34 +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	Move the OpenApi processing to ApiDocGenerator (#1671 )	2020-07-06 19:50:34 +02:00
OpenApiPhp	Move the OpenApi processing to ApiDocGenerator (#1671 )	2020-07-06 19:50:34 +02:00
PropertyDescriber	Move the OpenApi processing to ApiDocGenerator (#1671 )	2020-07-06 19:50:34 +02:00
Resources	Update swagger-ui (#1672 )	2020-07-04 16:26:54 +02:00
RouteDescriber	Fix access to api->components in RouteMetadataDescriber (#1635 )	2020-05-30 18:24:51 +02:00
Routing	Added name_patterns filter option (#1504 )	2019-04-16 17:22:50 +02:00
Tests	Move the OpenApi processing to ApiDocGenerator (#1671 )	2020-07-06 19:50:34 +02:00
Util	Merge pull request #1556 from maxhelias/reflection-method	2019-11-21 18:18:16 +01: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	Add areas support (#1169 )	2018-01-05 13:08:02 +01:00
.travis.yml	Merge branch '3.x'	2020-05-31 17:54:32 +02:00
ApiDocGenerator.php	Move the OpenApi processing to ApiDocGenerator (#1671 )	2020-07-06 19:50:34 +02:00
CHANGELOG.md	Merge branch 'v3'	2020-05-30 18:23:49 +02:00
composer.json	Merge branch '3.x'	2020-05-31 17:54:32 +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	OpenApi 3 Support (#1623 )	2020-05-28 13:19:11 +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

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.