exsyst/api-doc-bundle

This package is abandoned and no longer maintained. The author suggests using the nelmio/api-doc-bundle package instead.

Generates documentation for your REST API from annotations

dev-master / 0.1.x-dev 2016-12-17 11:42 UTC

README

[WIP] Generates Swagger docs from several sources

Installation

Just like any bundle, you have to download it using composer:

composer require exsyst/api-doc-bundle dev-master

And then add it to your kernel:

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...

            new EXSyst\Bundle\ApiDocBundle\ApiDocBundle(),
        ];

        // ...
    }
}

And that's all, no configuration needed!

What does this bundle?

It generates you a swagger documentation from your symfony app thanks to different sources called Describers. These Describers are specific to a library and extract data from it and merge it into your swagger documentation.

You can fetch your swagger documentation in your app:

$generator = $container->get('exsyst_api_doc.generator');
$swagger = $generator->generate()->toArray();

What's supported?

This bundle supports Symfony route requirements, PHP annotations, Swagger-Php annotations, NelmioApiDocBundle annotation, FOSRestBundle annotations and Api-Platform apps.

This bundle is a Work In Progress and as such it does only support input documentation for now (if you use Swagger-Php or Api-Platform output is supported as well).

What's next?

The hardest part remain: models. We have to build something to manage models that can vary based on several factors (serialization groups, class, etc.) and then put it in the app's documentation.

Other libraries support might be added but the priority is to finalize the bundle first.