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
966 commits 9 branches 28 tags 17 MiB
Find a file
Invis1ble 97c6b1e857 Fixed placeholder translations #889
2016-07-29 09:20:35 +03:00
Annotation Merge pull request #811 from InputOutput/allow-input-and-filters 2016-06-13 10:01:34 +02:00
Command Usage of OUTPUT_RAW to avoid javascript syntax error when dumping HTML API doc. Fixes issue #864. 2016-06-10 10:47:43 +02:00
Controller Introduce the concept of 'views' 2015-05-16 12:17:59 +02: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 #502 Hide Requirement when not set 2016-06-13 00:29:59 +02:00
Form/Extension Add symfony 3.0 support 2015-12-02 16:19:12 +01:00
Formatter Use the response map in the html view 2016-01-26 04:36:38 +01:00
Parser Merge pull request #799 from debesha/master 2016-02-24 17:46:38 +01:00
Resources Fixed placeholder translations #889 2016-07-29 09:20:35 +03:00
Swagger Tests for aliased collections; Swagger formatting for wrapped collections. 2014-09-04 11:19:54 -07:00
Tests Remove a test since #811 changes the behavior 2016-06-13 11:04:16 +02: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 Do not fail on Symfony 4.0 deprecation messages 2016-06-13 10:53:00 +02:00
composer.json Prepare 2.13.0 release 2016-06-13 11:12:09 +02: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 Fixed link to documentation 2016-03-21 14:47:18 +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