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

Go to file

anawaz 7b62443417 Updated SwaggerDocblockConvertCommand command in UPGRADE-3.0.md

- Allowed null input in `escapeQuotes(string $str)` - description of an API can be null
- Added command option `views` to input comma separated list of views - the API can have view(s) other than `default`

2018-03-19 13:24:55 +01:00

Annotation

Added support for @Security annotations (#1201 )

2018-01-25 21:11:34 +01:00

Controller

Add areas support (#1169 )

2018-01-05 13:08:02 +01:00

DependencyInjection

Allow to filter routes by host (#1121 )

2018-03-17 10:37:54 -03:00

Describer

Respect invalid argument syntax used by PHP at ApiPlatformDescriber::__construct()

2018-03-17 10:51:50 -03:00

Form/Extension

Add a documentation form extension (#1234 )

2018-02-19 10:56:51 +01:00

Model

Cleanup

2018-01-04 11:34:23 +01:00

ModelDescriber

Allow to change a property name

2018-02-19 21:42:56 +01:00

Resources

Allow to filter routes by host (#1121 )

2018-03-17 10:37:54 -03:00

RouteDescriber

Add a missing variable initialisation

2018-01-26 07:37:03 +01:00

Routing

Allow to filter routes by host (#1121 )

2018-03-17 10:37:54 -03:00

SwaggerPhp

Fix the invalid reference notice

2017-08-27 17:41:42 +02:00

Tests

Allow to filter routes by host (#1121 )

2018-03-17 10:37:54 -03:00

Util

Apply fixes from StyleCI

2017-12-22 17:42:18 +00:00

.gitignore

Fix the tests

2017-03-15 13:38:23 +01:00

.php_cs.dist

Allow implicit operations with SwaggerPhp annotations

2017-01-08 12:12:43 +01:00

.styleci.yml

Add areas support (#1169 )

2018-01-05 13:08:02 +01:00

.travis.yml

Update Travis config

2017-12-17 10:46:20 +01:00

ApiDocGenerator.php

Add areas support (#1169 )

2018-01-05 13:08:02 +01:00

CHANGELOG.md

Allow to filter routes by host (#1121 )

2018-03-17 10:37:54 -03:00

composer.json

Allow to filter routes by host (#1121 )

2018-03-17 10:37:54 -03:00

CONTRIBUTING.md

Document the bundle

2017-05-13 17:21:28 +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

Use phpunit 6

2017-05-31 19:36:17 +02:00

phpunit.xml.dist

Update travis config (#1117 )

2017-11-27 14:40:22 +01:00

README.md

Fixes

2018-01-04 17:47:47 +01:00

update-js.sh

Include map files

2017-06-22 21:22:10 +02:00

UPGRADE-3.0.md

Updated SwaggerDocblockConvertCommand command in UPGRADE-3.0.md

2018-03-19 13:24:55 +01:00

README.md

NelmioApiDocBundle

The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.

Migrate from 2.x to 3.0

To migrate from 2.x to 3.0, just 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.