mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-09 02:59:27 +03:00

Go to file

Merge pull request #1804 from JeResilieMonContrat-com/form_child_documentation

Display non native form type childs description and title properly

2021-08-03 09:37:16 +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

Merge pull request #1804 from JeResilieMonContrat-com/form_child_documentation

2021-08-03 09:37:16 +02:00

OpenApiPhp

Fix additionalProperties support

2021-06-07 19:23:02 +02:00

PropertyDescriber

Merge branch '3.x'

2020-12-10 22:28:55 +01:00

Resources

[Doc] Fix some minor RST issues

2021-07-16 17:39:22 +02:00

RouteDescriber

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

Merge pull request #1830 from nelmio/ADDPROP

2021-08-03 09:35:12 +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

Compound validation rule support (#1818 )

2021-06-16 09:59:06 +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.