RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-03 22:03:33 +03:00
Code Issues Projects Releases Wiki Activity
Generates documentation for your REST API from annotations
627 commits 9 branches 28 tags 17 MiB
Find a file
Paweł Mikołajczuk 55f26508ab Don't parse custom properties as classes. 
Sometimes instead real class name we can use custom handler name. Then this class can't be initialized and we will get this exception ```ReflectionException: Class custom_handler_name does not exist```
2014-07-10 11:46:30 +02:00
Annotation Merge pull request #358 from pborreli/typos 2014-06-27 10:22:56 +02: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 Unified data types [actualType and subType] 2014-06-27 09:35:18 +02:00
EventListener make form and validation extractors optional 2013-10-28 19:12:43 +01:00
Extractor Added 'default' parameters in {JmsMetadata,Validator}Parser, and FOSRestHandler. 2014-06-27 10:19:28 +02:00
Form/Extension Fixed BC Break from master (commit d072f35ea0 ) 2012-07-23 13:01:23 +03:00
Formatter Add missing array key checks 2014-06-27 10:07:03 +02:00
Parser Don't parse custom properties as classes. 2014-07-10 11:46:30 +02:00
Resources added fix for doubled parameters 2014-07-07 09:08:21 +00:00
Tests Parse JSM\Inline, fixes #372 2014-07-08 13:20:13 +02: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 Replace deprecated fork of dflydev's mardown library with the original one provided by Michel Fortin 2014-02-19 12:55:16 +01:00
CONTRIBUTING.md Add a note about PR desc in CONTRIBUTING file 2013-11-14 12:07:19 +01:00
DataTypes.php added file type to FormType Parser 2014-06-25 10:25:45 +02: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

Build Status

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