Developed with love by KnpLabs Hire us for your project!
872

NelmioApiDocBundle

by nelmio

Generates documentation for your REST API from annotations

NelmioApiDocBundle

Build<br>
Status
Total Downloads
Latest Stable<br>
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
Copyright (c) 2012 Nelmio

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
nelmio_api_doc:
name: API documentation
exclude_sections: []
default_sections_opened: true
motd:
template: NelmioApiDocBundle::Components/motd.html.twig
request_listener:
enabled: true
parameter: _doc
sandbox:
enabled: true
endpoint: ~
accept_type: ~
body_format:
formats:

# Defaults:
- form
- json
default_format: form
request_format:
formats:

# Defaults:
json: application/json
xml: application/xml
method: format_param
default_format: json
authentication:
delivery: ~ # Required
name: ~ # Required

# Required if http delivery is selected.
type: ~
custom_endpoint: false
swagger:
model_naming_strategy: dot_notation
api_base_path: /api
swagger_version: 1.2
api_version: 0.1
info:
title: Symfony2
description: My awesome Symfony2 app!
TermsOfServiceUrl: ~
contact: ~
license: ~
licenseUrl: ~
cache:
enabled: false
file: %kernel.cache_dir%/api-doc.cache
  • Merge pull request #612 from dunglas/patch-2
    By willdurand, 1 year ago
  • Fix broken image in README.md
    By dunglas, 1 year ago
  • Merge pull request #610 from dunglas/enhanced_dngls_api
    By willdurand, 1 year ago
  • Merge pull request #611 from dunglas/patch-1
    By willdurand, 1 year ago
  • Enhanced DunglasApiBundle support
    By dunglas, 1 year ago
  • Use new Travis infrastructure. Test with PHP7.
    By dunglas, 1 year ago
  • Merge pull request #602 from snamor/patch-1
    By willdurand, 1 year ago
  • Optimization on the regex
    By , 1 year ago
  • Add the commas to the prettified JSON
    By snamor, 1 year ago
  • Merge pull request #599 from dunglas/fix_dunglas
    By willdurand, 1 year ago
  • Fix DunglasJsonLdApiBundle support
    By dunglas, 1 year ago
  • Merge pull request #597 from leberknecht/feature-collapsible-json-response
    By willdurand, 1 year ago
  • -fixed binding of on-click handler for json-toggler, - fixed css-class naming
    By leberknecht, 1 year ago
  • - added javascript for collapsing sections in json-response, - fixed usage of private service-alias (that will be removed by RemovePrivateAliases-compiler pass)
    By leberknecht, 1 year ago
  • Merge pull request #560 from wodka/patch-1
    By willdurand, 1 year ago
  • Merge pull request #593 from AlmogBaku/patch-1
    By willdurand, 1 year ago
  • fixes: not attaching `api_key` to query if empty
    By AlmogBaku, 1 year ago
  • Merge pull request #585 from dunglas/dunglasjsonldapibundle
    By willdurand, 1 year ago
  • DunglasJsonLdApiBundle support
    By dunglas, 1 year ago
  • Merge pull request #584 from PedroTroller/feature/form-options
    By willdurand, 1 year ago
  • Add form options to ApiDoc input
    By PedroTroller, 1 year ago
  • update branch-alias (composer)
    By willdurand, 1 year ago
  • cs
    By willdurand, 1 year ago
  • Merge pull request #573 from jcrombez/patch-1
    By willdurand, 1 year ago
  • [doc] missing "sandbox:" in the authentication yaml examples
    By jcrombez, 1 year ago
  • Merge pull request #562 from lmammino/patch-1
    By willdurand, 2 years ago
  • Fixed type annotations
    By lmammino, 2 years ago
  • fix sandbox with host
    By wodka, 2 years ago
  • Merge pull request #555 from damienalexandre/fixLinkParser
    By willdurand, 2 years ago
  • Fix the PhpDoc Handler for `@link` annotation and add tests
    By damienalexandre, 2 years ago