README

[WIP] 从多个来源生成 Swagger 文档

安装

就像任何bundle一样，您需要使用composer下载它

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

然后将它添加到您的kernel中

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

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

        // ...
    }
}

这就完成了，无需配置！

此bundle是做什么的？

它通过不同的来源（称为 Describers）生成您的swagger文档。这些 Describers 针对特定的库，从中提取数据并将其合并到您的swagger文档中。

您可以在您的应用程序中获取swagger文档

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

支持什么？

此bundle支持 Symfony 路由要求，PHP 注释，Swagger-Php 注释，NelmioApiDocBundle 注释，FOSRestBundle 注释和 Api-Platform 应用。

此bundle是 进行中，因此目前只支持输入文档（如果使用 Swagger-Php 或 Api-Platform，则支持输出）。

接下来是什么？

最困难的部分仍然是：模型。我们必须构建一些东西来管理基于多个因素（序列化组、类等）变化的模型，然后将它们放入应用程序的文档中。

可能会添加其他库的支持，但优先级是首先完成此bundle。

exsyst/api-doc-bundle

维护者

详细信息

README

安装

此bundle是做什么的？

支持什么？

接下来是什么？