RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-02 21:36:14 +03:00
Code Issues Projects Releases Wiki Activity
Generates documentation for your REST API from annotations
545 commits 9 branches 28 tags 17 MiB
Find a file
Paweł Mikołajczuk 32e37dbd8a Don't try to call class with custom handlers. 
With JMS Serializer you can set up own type and use it later with custom handler for this property - Parser allways try to call that custom property type like a class. This fix that.
2014-02-03 16:57:46 +01:00
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 Added exclude_envs to ApiDoc annotation to exclude the documentation from the specified environments 2014-01-20 13:24:41 +01:00
EventListener make form and validation extractors optional 2013-10-28 19:12:43 +01:00
Extractor Fix HTTPS detection 2014-01-20 14:18:02 +01:00
Form/Extension Fixed BC Break from master (commit d072f35ea0 ) 2012-07-23 13:01:23 +03:00
Formatter Fix undefined index in AbstractFormatter 2013-12-16 16:47:21 +01:00
Parser Don't try to call class with custom handlers. 2014-02-03 16:57:46 +01:00
Resources Fixed typo in index.md documentation 2014-01-21 10:41:55 +01:00
Tests Added exclude_envs to ApiDoc annotation to exclude the documentation from the specified environments 2014-01-20 13:24:41 +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 travis-ci config 2013-12-05 21:36:37 +01:00
composer.json Fix travis-ci config 2013-12-05 21:36:37 +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

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