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

Go to file

rajasaur 9eee2e263f Fix DumpCommand to generate html with/out sandbox

api:doc:dump --format=html always disables the Sandbox since the check in
DumpCommand seems to be wrong. Fixed that as well as introduce a dummy
Request Object as the layout.html.twig expects an app.request object.

2013-12-06 15:28:19 +05:30

Annotation

Merge pull request #206 from dothiv/master

2013-11-14 11:17:06 +01:00

Command

Fix DumpCommand to generate html with/out sandbox

2013-12-06 15:28:19 +05:30

Controller

Fixed rendering issue when used with FOSRestBundle and configured to not

2012-08-23 15:09:56 +02:00

DependencyInjection

Fix incompatibility with Symfony2 2.1

2013-11-14 11:00:44 +01:00

EventListener

make form and validation extractors optional

2013-10-28 19:12:43 +01:00

Extractor

Merge output parameters

2013-11-16 17:29:23 +01:00

Form/Extension

Fixed BC Break from master (commit d072f35ea0 )

2012-07-23 13:01:23 +03:00

Formatter

Fix CS

2013-11-14 10:33:57 +01:00

Parser

Add support of All constraint

2013-11-18 10:24:56 +01:00

Resources

Move doc to its own folder

2013-11-14 11:43:09 +01:00

Tests

Add support of All constraint

2013-11-18 10:24:56 +01:00

Twig/Extension

Fix Twig filter name

2012-07-20 17:38:39 +02:00

Util

abstracted docblock comment extraction, implemented in JmsMetadataParser to get parameter descriptions

2012-08-31 14:57:42 -04:00

.gitignore

Added phpunit.xml to the ignore file

2012-05-23 00:43:18 +02:00

.travis.yml

Fix composer again

2013-11-14 17:01:56 +01:00

composer.json

Fix composer again

2013-11-14 17:01:56 +01:00

CONTRIBUTING.md

Add a note about PR desc in CONTRIBUTING file

2013-11-14 12:07:19 +01:00

NelmioApiDocBundle.php

make form and validation extractors optional

2013-10-28 19:12:43 +01:00

phpunit.xml.dist

Ignore vendor in code coverage

2012-04-13 15:21:45 +02:00

README.md

Typo fix

2013-11-15 13:29:32 +03:00

README.md

NelmioApiDocBundle

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

Important: This bundle is developed in sync with symfony's repository. For Symfony 2.0.x, you need to use the 1.* version of the bundle.

Documentation

For documentation, see:

Resources/doc/

Read the documentation

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dev dependencies:

php composer.phar install --dev

Then, run the test suite using PHPUnit:

phpunit

Credits

The design is heavily inspired by the swagger-ui project. Some icons from the Glyphicons library are used to render the documentation.

License

This bundle is released under the MIT license. See the complete license in the bundle:

Resources/meta/LICENSE