RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-08 11:42:07 +00:00
Code Issues Projects Releases Wiki Activity
Generates documentation for your REST API from annotations
511 commits 9 branches 28 tags 17 MiB
Find a file
Filip Benčo d932b06bbb
Add support for compound properties (#1651) 
* Add support for compound properties

* Fix CS & Tests

* Another fixing :D

* Final CS fix

* Allow complex compound properties

* cs

* Update the Upgrading guide

* Update php doc

* Add Support for Nullable properties

* Fix CS

* Fix CS

* Add Support for Nullable Types & Schemas as in OA3

* Update Nullable Property handling

* CS

* Fix tests

* Accept also nullable config for Alternative model names

* Refactor nullable refs

* Fix CS & Tests

* Another CS

* Revert "Another CS"

This reverts commit 03ada32b3263f3537d2af63f0abe79bd4a9ac0b5.

* Revert "Fix CS & Tests"

This reverts commit 369f2ccd170aebeeb9d87e9e00cba5cea62d5529.

* Revert "Refactor nullable refs"

This reverts commit 91cdf6fd0130f3ebf415de99f8a91edbc764255e.

* Revert "Revert "Refactor nullable refs""

This reverts commit 0e50fc1938ce3e620fc655a7d1e9284a9f8c24f0.

* Revert "Revert "Fix CS & Tests""

This reverts commit 228d3ca994eb4622c4db81aaa5f32845862e5616.

* Revert "Revert "Another CS""

This reverts commit a5b08dedf5bca8fb711b816c62bed2de9f1c9521.

* Improve nullable refs description

Co-authored-by: Filip Benčo <filip.benco@websupport.sk>
Co-authored-by: Guilhem Niot <guilhem.niot@gmail.com>
2020-06-16 13:11:53 +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 Remove deprecated features (#1640) 2020-05-31 18:18:29 +02:00
Describer Fix #1628 : annotations construction is context dependant (#1632) 2020-05-29 21:52:06 +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 Add support for compound properties (#1651) 2020-06-16 13:11:53 +02:00
OpenApiPhp Fix undefined property $this->mediaType (#1633) 2020-05-29 18:53:58 +02:00
PropertyDescriber Add support for compound properties (#1651) 2020-06-16 13:11:53 +02:00
Resources Add support for compound properties (#1651) 2020-06-16 13:11:53 +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 Add support for compound properties (#1651) 2020-06-16 13:11:53 +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 OpenApi 3 Support (#1623) 2020-05-28 13:19:11 +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

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.