Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Generates documentation for your REST API from annotations
PHP HTML CSS

Merge pull request #695 from ogizanagi/fix_callable_controllers

Fix ApiDocExtractor to accept callable classes as controllers
latest commit 874c8752e6
@willdurand willdurand authored
Failed to load latest commit information.
Annotation Introduce the concept of 'views'
Command Added view option to api:doc:dump command
Controller Introduce the concept of 'views'
DependencyInjection Improve true/false/null default values on configuration
EventListener make form and validation extractors optional
Extractor Fix ApiDocExtractor to accept callable classes as controllers
Form/Extension Fix deprecated FormType::setDefaultOptions usage
Formatter cs
Parser Add support for using `name` in the input and output options for Json…
Resources Add support for using `name` in the input and output options for Json…
Swagger Tests for aliased collections; Swagger formatting for wrapped collect…
Tests Fix extractor view data caching
Twig/Extension Replace deprecated fork of dflydev's mardown library with the origina…
Util abstracted docblock comment extraction, implemented in JmsMetadataPar…
.gitignore Removed IntelliJ stuff from gitignore
.travis.yml Include Symfony 2.7 stable on Travis and improve configuration
CONTRIBUTING.md Add a note about PR desc in CONTRIBUTING file
DataTypes.php cs
NelmioApiDocBundle.php DunglasJsonLdApiBundle support
README.md Fix broken image in README.md
change update branch-alias (composer)
composer.json Prevent BC break in DunglasApiBundle
phpunit.xml.dist Ignore vendor in code coverage

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
Something went wrong with that request. Please try again.