ApiDocBundle

[WIP] Generates Swagger docs from several sources, _(*1)

Installation

Just like any bundle, you have to download it using composer:, _(*2)

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

And then add it to your kernel:, _(*3)

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

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

        // ...
    }
}

And that's all, no configuration needed!, _(*4)

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., _(*5)

You can fetch your swagger documentation in your app:, _(*6)

$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., _(*7)

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)., _(*8)

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., _(*9)

Other libraries support might be added but the priority is to finalize the bundle first., _(*10)