luckynvic/yii2-rest-doc

Yii2 REST 文档生成器

维护者

详细信息

github.com/luckynvic/yii2-rest-doc

主页

源代码

问题

安装数: 18,831

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

类型:yii2-extension

0.0.3-beta 2016-08-17 23:16 UTC

Requires

BSD-3-Clause 1f61e1717f445251d63ccdd461a5174950015fb0

  • Lucky Vic <luckynvic.woop@gmail.com>

generatordocumentationrestyii2

This package is not auto-updated.

Last update: 2024-09-14 19:25:42 UTC

README

Yii2 rest api 文档生成器。此扩展使用 yii console 通过 php-apidoc 构建 rest api 文档。

安装

建议使用 composer 安装，运行以下命令：

composer require luckynvic/yii2-rest-doc "*"

或者，您可以手动将以下内容添加到您的 composer.json 文件中的 require 部分

"luckynvic/yii2-rest-doc": "*"

之后运行 composer update。

配置

将以下内容添加到您的控制台配置中

    'controllerMap' => [
        'build-rest-doc' => [
            'class' => '\luckynvic\restdoc\BuilderController',
            'sourceDirs' => [
                '@api/controllers', // api controller path
            ],
            'outputDir' => 'docs/rest',
            'outputFile' => 'index.html',
            //optional
            'templatePath' => dirname(__DIR__).'/../docs/rest/template/index.html', 
        ],
    ],