mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00

Go to file

Merge pull request #2019 from goetas/context

use the configured context factory to create the serialization context

2022-08-29 22:56:41 +02:00

.github/workflows

Allow symfony/flex composer plugin (#2013 )

2022-07-18 17:58:10 +02:00

Annotation

check $properties['value'] is not empty

2022-02-02 08:47:26 -08:00

Command

Enable overriding server url for yaml and json export from console

2021-07-29 12:22:54 +02:00

Controller

Catch a more precise exception in Swagger controller (#2005 )

2022-06-10 23:17:15 +02:00

DependencyInjection

use the configured context factory to create the serialization context

2022-08-22 20:45:23 +02:00

Describer

Add support of inline path parameters (#1973 )

2022-03-28 14:37:14 +02:00

Exception

Catch a more precise exception in Swagger controller (#2005 )

2022-06-10 23:17:15 +02:00

Form/Extension

Allow to not document form types fields (#1752 )

2020-12-02 15:38:38 +01:00

Model

Merge pull request #1988 from nelmio/ROOTCONTEXT

2022-06-10 20:52:06 +02:00

ModelDescriber

use the configured context factory to create the serialization context

2022-08-22 20:45:23 +02:00

OpenApiPhp

fix CS

2022-04-30 20:10:00 +02:00

PropertyDescriber

Use the same root context everywhere

2022-04-30 20:07:44 +02:00

Render

Catch a more precise exception in Swagger controller (#2005 )

2022-06-10 23:17:15 +02:00

Resources

Update index.rst (#2015 )

2022-08-04 11:58:28 +02:00

RouteDescriber

Use the same root context everywhere

2022-04-30 20:07:44 +02:00

Routing

Add support for php attributes (#1932 )

2021-12-21 16:16:14 +01:00

Tests

Merge pull request #1902 from chrisguitarguy/constraint_groups

2022-06-10 16:15:42 -05:00

Util

2022-03-21 17:04:37 +01:00

.doctor-rst.yaml

Add a Github Action to lint the docs

2022-05-12 23:59:12 +02:00

.gitattributes

Exclude development files from dist package

2020-09-28 10:36:17 -03:00

.gitignore

Add support for php attributes (#1932 )

2021-12-21 16:16:14 +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

Use the same root context everywhere

2022-04-30 20:07:44 +02:00

CHANGELOG.md

Release version 3.7

2020-08-12 11:06:17 +02:00

composer.json

Fix wrong package name

2022-05-27 17:44:13 +03: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

Increase tests memory limit

2022-06-11 09:54:36 +02: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

Fix DOCtor-RST errors

2022-05-12 23:59:36 +02:00

UPGRADE-4.0.md

Update link to zircote/swagger-php upgrade documentation

2022-02-28 11:54:53 +01: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.