mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-02 21:36:14 +03:00

Generates documentation for your REST API from annotations

Find a file

William Durand f2a80511a7 Merge pull request #313 from maxromanovsky/patch-1 Misspelled authentication config parameter in docs		2014-01-13 06:26:52 -08: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	Improve documentation (authentication/sandbox)	2014-01-10 11:20:22 +01:00
EventListener	make form and validation extractors optional	2013-10-28 19:12:43 +01:00
Extractor	Merge PR #299 from SimonSimCity/https-fixes	2013-12-28 18:55:06 +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	select used parsers	2013-12-28 18:41:59 +01:00
Resources	Misspelled authentication config parameter in docs	2014-01-13 14:53:28 +03:00
Tests	Hide “_scheme” in the list of requirements per URL	2013-12-28 18:52:32 +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

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