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

Go to file

William Durand d32381d18d Merge pull request #476 from bezhermoso/swagger-collection-parameter

[Fix] Missing handling for DataTypes::COLLECTION in parameters (input)

2014-08-16 14:29:11 +02:00

Annotation

Swagger support:

2014-07-29 10:25:05 -07:00

Command

Swagger support:

2014-07-29 10:25:05 -07:00

Controller

Swagger support:

2014-07-29 10:25:06 -07:00

DependencyInjection

Added definition when is provided.

2014-08-04 10:58:41 -07:00

EventListener

make form and validation extractors optional

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

Extractor

Added caching layer with the controllers and routing files as resources.

2014-07-31 00:43:59 -07:00

Form/Extension

Fixed BC Break from master (commit d072f35ea0 )

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

Formatter

Merge pull request #476 from bezhermoso/swagger-collection-parameter

2014-08-16 14:29:11 +02:00

Parser

Default to DataTypes::STRING

2014-08-04 10:02:18 -07:00

Resources

Merge pull request #468 from bezhermoso/param_type_options

2014-08-14 21:44:53 +02:00

Tests

Added definition when is provided.

2014-08-04 10:58:41 -07:00

Twig/Extension

Replace deprecated fork of dflydev's mardown library with the original one provided by Michel Fortin

2014-02-19 12:55:16 +01: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

remove php 5.3 from travis-ci

2014-06-27 14:43:22 +02:00

composer.json

Prepare 2.7.0 release

2014-07-30 11:11:08 +02:00

CONTRIBUTING.md

Add a note about PR desc in CONTRIBUTING file

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

DataTypes.php

Swagger support:

2014-07-29 10:25:05 -07:00

NelmioApiDocBundle.php

Swagger support:

2014-07-29 10:25:05 -07:00

phpunit.xml.dist

Ignore vendor in code coverage

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

README.md

Add poser badges

2014-07-30 11:17:22 +02: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