RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-01 21:06:15 +03:00
Code Issues Projects Releases Wiki Activity
Generates documentation for your REST API from annotations
743 commits 9 branches 28 tags 17 MiB
Find a file
Michael Schramm 10d9172d26 fix sandbox with host 
suggested change in https://github.com/nelmio/NelmioApiDocBundle/pull/353 is not working
2014-12-30 00:00:27 +01:00
Annotation Fixed checking HTTP method type 2014-09-29 16:17:36 +02:00
Command Behavior and usage updates. 2014-08-01 12:56:46 -07:00
Controller adding optional color codes for tags annotation 2014-08-25 11:27:49 +02:00
DependencyInjection Alternate model naming strategy. 2014-08-25 10:14:04 -07:00
EventListener make form and validation extractors optional 2013-10-28 19:12:43 +01:00
Extractor Fix the PhpDoc Handler for @link annotation and add tests 2014-12-12 16:13:55 +01:00
Form/Extension Fixed BC Break from master (commit d072f35ea0 ) 2012-07-23 13:01:23 +03:00
Formatter Form errors parser. Mirrored actual form-errors response by FOSRest. Made sure that FieldErrors is not duplicated. 2014-10-10 11:59:19 -07:00
Parser Form errors parser. Mirrored actual form-errors response by FOSRest. Made sure that FieldErrors is not duplicated. 2014-10-10 11:59:19 -07:00
Resources fix sandbox with host 2014-12-30 00:00:27 +01:00
Swagger Tests for aliased collections; Swagger formatting for wrapped collections. 2014-09-04 11:19:54 -07:00
Tests Fix the PhpDoc Handler for @link annotation and add tests 2014-12-12 16:13:55 +01: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 EOLed Symfony versions from Travis 2014-09-10 14:29:24 +02:00
composer.json Added support for Security annotation 2014-08-28 00:12:34 +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 Remove outdated note 2014-10-21 21:24:09 +01:00

README.md

NelmioApiDocBundle

Build Status Total Downloads Latest Stable Version

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

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