Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Generates documentation for your REST API from annotations

Merge pull request #573 from jcrombez/patch-1

[doc] missing "sandbox:" in the authentication yaml examples
latest commit e23a7d7d66
William Durand willdurand authored
Failed to load latest commit information.
Annotation Fixed checking HTTP method type
Command Behavior and usage updates.
Controller adding optional color codes for tags annotation
DependencyInjection Alternate model naming strategy.
EventListener make form and validation extractors optional
Extractor Fixed type annotations
Form/Extension Fixed BC Break from master (commit symfony/symfony@d072f35 )
Formatter Form errors parser. Mirrored actual form-errors response by FOSRest. …
Parser Form errors parser. Mirrored actual form-errors response by FOSRest. …
Resources [doc] missing "sandbox:" in the authentication yaml examples
Swagger Tests for aliased collections; Swagger formatting for wrapped collect…
Tests Fix the PhpDoc Handler for `@link` annotation and add tests
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 Remove EOLed Symfony versions from Travis
CONTRIBUTING.md Add a note about PR desc in CONTRIBUTING file
DataTypes.php Swagger support:
NelmioApiDocBundle.php Swagger support:
README.md Remove outdated note
composer.json Added support for Security annotation
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.