RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-02 13:26:13 +03:00
Code Issues Projects Releases Wiki Activity
Generates documentation for your REST API from annotations
1005 commits 9 branches 28 tags 17 MiB
Find a file
Exact
Vitaliy Chesnokov 99b9d4f486
Fix generateHumanReadableTypes
2019-04-29 12:39:48 +03:00
Annotation * Range Constraint parsing in the ValidationParser 2019-04-25 21:55:41 +03:00
Command Check the version in methods response 2019-04-25 21:50:32 +03:00
Controller Check the version in methods response 2019-04-25 21:50:32 +03:00
DependencyInjection Improve true/false/null default values on configuration 2015-06-07 11:34:26 +02:00
EventListener make form and validation extractors optional 2013-10-28 19:12:43 +01:00
Extractor Fix generateHumanReadableTypes 2019-04-29 12:39:48 +03:00
Form/Extension Add symfony 3.0 support 2015-12-02 16:19:12 +01:00
Formatter Removed duplicated constraints in Format field. Improved format for field type of form 2019-04-29 12:39:48 +03:00
Parser Removed duplicated constraints in Format field. Improved format for field type of form 2019-04-29 12:39:48 +03:00
Resources Form labels translation support. 2019-04-25 21:55:45 +03:00
Swagger Tests for aliased collections; Swagger formatting for wrapped collections. 2014-09-04 11:19:54 -07:00
Tests Removed duplicated constraints in Format field. Improved format for field type of form 2019-04-29 12:39:48 +03:00
Twig/Extension Change visibility of markdownParser property to protected, to improve extendability 2016-03-23 10:25:51 +01:00
Util Add symfony 3.0 support 2015-12-02 16:19:12 +01:00
.gitignore Added phpunit.xml to the ignore file 2012-05-23 00:43:18 +02:00
.travis.yml Update .travis.yml 2016-09-10 00:38:59 +03:00
composer.json [2.x] Fix compatibility with Symfony 3.4 and 4.0 2017-12-04 23:11:29 +01:00
CONTRIBUTING.md Add a note about PR desc in CONTRIBUTING file 2013-11-14 12:07:19 +01:00
DataTypes.php cs 2015-03-06 11:19:08 +01:00
NelmioApiDocBundle.php DunglasJsonLdApiBundle support 2015-03-20 09:53:48 +01:00
phpunit.xml.dist Ignore vendor in code coverage 2012-04-13 15:21:45 +02:00
README.md Update the documentation link 2017-05-13 16:53:58 +02: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

Read the documentation on symfony.com

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