Skip to content

itkg/api-doc-bundle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b742173 · Mar 26, 2015

History

15 Commits
Mar 25, 2015
Mar 25, 2015
Mar 24, 2015
Mar 25, 2015
Mar 25, 2015
Mar 25, 2015
Mar 25, 2015
Mar 25, 2015
Mar 26, 2015
Mar 24, 2015
Mar 25, 2015
Mar 24, 2015
Mar 25, 2015
Mar 23, 2015

Repository files navigation

api-doc-bundle

Provide additional features on top of NelmioApiDocBundle

Build Status Scrutinizer Code Quality Code Coverage SensioLabsInsight

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

About

Provide additional features on top of NelmioApiDocBundle

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages