itkg/api-doc-bundle

API doc bundle

v1.0.0 2015-03-26 08:37 UTC

Requires

• php: >=5.3.3
• erusev/parsedown: ~1
• nelmio/api-doc-bundle: ~2
• symfony/symfony: ~2

Requires (Dev)

• phpunit/phpunit: 4.*

MIT

• Pascal DENIS

• api
• bundle
• doc
• interakting

README

Provide additional features on top of NelmioApiDocBundle

Features

• Resources annotation to provide list of markdown files
• New method pane (resources pane) to display markdown resources as HTML (using Parsedown library)

Installation

Installation by Composer

If you use composer, add ItkgApiDocBundle bundle as a dependency to the composer.json of your application

     "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