itkg/api-doc-bundle

API doc bundle

api-doc-bundle

Provide additional features on top of NelmioApiDocBundle, _(*1)

, _(*2)

Features * Resources annotation to provide list of markdown files * New method pane (resources pane) to display markdown resources as HTML (using Parsedown library), _(*3)

Installation

Installation by Composer

If you use composer, add ItkgApiDocBundle bundle as a dependency to the composer.json of your application, _(*4)

     "require": {
         "itkg/api-doc-bundle": "dev-master"
     }

• Add Itkgapi-docBundle to your application kernel.

// app/AppKernel.php
<?php
     // ...
     public function registerBundles()
     {
         $bundles = array(
             // ...
             new Itkg\ApiDocBundle\ItkgApiDocBundle(),
         );
     }

• Activate bundle config in application's config.yml file by addng :

itkg_api_doc: ~

Todo

• Export Documentation API with resources as PDF