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

Find a file

Guilhem Niot 1023ae2453 Merge branch 3.x		2021-06-14 13:25:30 +02:00
.github/workflows	Change the management of the cache of composer	2021-06-07 18:52:44 +02:00
Annotation	Support oauth2 scopes in Security annotation	2021-01-26 19:08:53 +01:00
Command	Fix ServerVariable management (#1694 )	2020-08-11 16:44:05 +02:00
Controller	Revert DocumentationController name	2021-02-08 22:54:21 +01:00
DependencyInjection	Merge branch '3.x'	2021-04-23 15:18:59 +02:00
Describer	Support oauth2 scopes in Security annotation	2021-01-26 19:08:53 +01:00
Exception	Fix CS	2020-11-20 17:10:21 +01:00
Form/Extension	Allow to not document form types fields (#1752 )	2020-12-02 15:38:38 +01:00
Model	Add support for compound properties (#1651 )	2020-06-16 13:11:53 +02:00
ModelDescriber	Add a check for Constraint class existing before using it	2021-06-11 07:23:54 +02:00
OpenApiPhp	Fix ServerVariable management (#1694 )	2020-08-11 16:44:05 +02:00
PropertyDescriber	Merge branch '3.x'	2020-12-10 22:28:55 +01:00
Resources	Updates documentation to show a side effect of design decision.	2021-05-30 21:00:03 -07:00
RouteDescriber	CS	2021-04-23 15:21:04 +02:00
Routing	Fix calls to nonexistent method `ControllerReflector::getReflectionClassAndMethod()`	2021-03-14 17:19:25 +01:00
Tests	Explictly enable property access in the tests (related to https://github.com/symfony/symfony/pull/40140 , it is a dev dependency)	2021-06-07 19:04:16 +02:00
Util	Supports reflection for routes configured in PHP files. (#1701 )	2020-08-11 16:46:05 +02:00
.gitattributes	Exclude development files from dist package	2020-09-28 10:36:17 -03:00
.gitignore	Add php 8 support (#1745 )	2020-12-10 21:59:36 +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
.symfony.bundle.yaml	Change in a config file	2021-03-23 14:29:59 +01: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	Allow psr/cache versions 2 and 3	2021-04-19 14:56:15 +02:00
CONTRIBUTING.md	Add php 8 support (#1745 )	2020-12-10 21:59:36 +01: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	Add php 8 support (#1745 )	2020-12-10 21:59:36 +01:00
phpunit.bat	Fix Declaration must be compatible error with tests (#1638 )	2020-05-31 15:16:51 +02:00
phpunit.xml.dist	Let PHPUnit fail on warnings and risky tests	2021-03-14 17:18:13 +01:00
README.md	Merge branch '3.x'	2020-12-29 10:30:06 +01: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.