README

此项目不再维护

添加生成 nelmio api 文档的命令

安装

使用 Symfony Flex 的应用程序

打开命令控制台，进入您的项目目录并执行

$ composer require kbunel/nelmio-api-doc-generator --dev --update-with-dependencies

未使用 Symfony Flex 的应用程序

步骤 1：下载包

打开命令控制台，进入您的项目目录并执行以下命令以下载此包的最新稳定版本

$ composer require kbunel/nelmio-api-doc-generator --dev --update-with-dependencies

此命令需要您全局安装 Composer，如 Composer 文档中的安装章节所述。

步骤 2：启用包

然后，通过将其添加到项目 app/AppKernel.php 文件中注册的包列表中，启用此包

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        if (in_array($this->getEnvironment(), array('dev', 'test'))) {
            // ...
            $bundles[] = new NelmioApiDocGenerator\NelmioApiDocGeneratorBundle();
            $bundles[] = new FileAnalyzer\FileAnalyzerBundle();
        }

        // ...
    }

    // ...
}

NelmioApiDocGeneratorBundle 配置

生成器将解析文件并尝试获取信息。如果您在控制器动作中使用了自定义函数来序列化数据并具有特定的分组，处理 HTTP 响应的函数或包含数据变量的返回函数。

serialization_groups: 处理序列化分组的函数 http_responses: 处理 HTTP 响应的函数 return: 处理返回数据的函数

nelmio_api_doc_generator:
    functions:
        serialization_groups:
            - customFunction
        http_responses:
            - customFunction
        return:
            - customFunction

命令

要生成测试，请运行

$ php bin/console kbunel:nelmioApiDoc:generate

可用选项

为特定路由生成文档

namespace: 控制器命名空间。 action: 控制器中路由的函数名称。

$ php bin/console kbunel:nelmioApiDoc:generate route=namespace::action

kbunel / nelmio-api-doc-generator

维护者

详细信息