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 #630 from munkie/dump-command-views

Add view option to api:doc:dump command
latest commit 5de5d530dd
@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 fix memory limit issue wirh entity list
EventListener make form and validation extractors optional
Extractor Introduce the concept of 'views'
Form/Extension Fix deprecated forms setDefaultOptions method
Formatter cs
Parser Merge pull request #586 from PedroTroller/fix/subform-options
Resources Update index.md
Swagger Tests for aliased collections; Swagger formatting for wrapped collect…
Tests Added view option to api:doc:dump command
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 Test against PHP 5.6
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 Added view option to api:doc:dump command
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.