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

Go to file

Christopher Davis d8626c2735 Introduce a Trait to Build OpenAPI Discriminators

See https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/

This is the adapter layer that will be included in the various model
describers. The creation of the discriminator and the `oneOf` values is
a little finicky and I wanted it to be tested and centralized.

2021-02-01 08:37:20 -06:00

.github/workflows

Fix github actions

2020-12-10 22:40:50 +01: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

Merge branch '3.x'

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

DependencyInjection

Merge branch '3.x'

2020-12-29 10:30:06 +01:00

Describer

Fix a regression about manual paths in operation no longer being taken into account

2020-12-27 19:14:14 +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

Introduce a Trait to Build OpenAPI Discriminators

2021-02-01 08:37:20 -06: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

Merge branch '3.x'

2020-12-29 10:30:06 +01:00

RouteDescriber

Merge pull request #1740 from nelmio/refparams

2020-11-03 10:32:13 +01:00

Routing

Fix cs

2020-12-10 22:30:50 +01:00

Tests

Introduce a Trait to Build OpenAPI Discriminators

2021-02-01 08:37:20 -06: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

ApiDocGenerator.php

Disable the OperationId processor (#1685 )

2020-07-24 08:37:58 +02:00

CHANGELOG.md

Merge branch '3.x'

2020-07-24 17:00:10 +02:00

composer.json

Merge branch '3.x'

2020-12-17 00:06:17 +01: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

Allow Symfony 5

2019-11-29 13:59:27 +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.