eold/yii2-apidoc-generator

为您的yii2 RESTFul API生成Apidoc.js格式的简单注释生成器

维护者

详情

github.com/enryold/yii2-apidoc-generator

源码

问题

安装数： 8,965

依赖: 0

建议: 0

安全: 0

星标: 8

关注者: 2

分支: 4

开放问题: 5

类型：yii2-extension

v1.0.2 2015-07-21 10:36 UTC

Requires (Dev)

BSD 13ebd8d3b2d60771aad84b3bea7cbf769109bb43

  • Enrico Vecchio <enrico.vecchio1.woop@gmail.com>

generatoryii2apidocapidoc.js

This package is not auto-updated.

Last update: 2024-10-02 10:18:10 UTC

README

Yii2 Apidoc.js 生成器

Yii2 Apidoc.js 生成器是一个小助手，用于按需为您的yii2 RESTFul API动作生成Apidoc.js注释。只需调用API端点来生成注释文件。然后运行apidoc脚本来生成您的文档。

先决条件

安装Apidoc.js (http://apidocjs.com/)

npm install apidoc -g

在项目中添加Apidoc生成器

 "eold/yii2-apidoc-generator": "^1.0."

配置

将apidoc-generator放入您的Yii2配置文件components中

'docGenerator' =>[
            'class' => 'eold\apidocgen\src\ApiDocGenerator',
            'isActive'=>true,                      // Flag to set plugin active
            'versionRegexFind'=>'/(\w+)(\d+)/i',   // regex used in preg_replace function to find Yii api version format (usually 'v1', 'vX') ... 
            'versionRegexReplace'=>'${2}.0.0',     // .. and replace it in Apidoc format (usually 'x.x.x')
            'docDataAlias'=>'@runtime/data_path'   // Folder to save output. make sure is writable. 
        ],

然后，在bootstrap部分添加apidoc-generator

'bootstrap' => ['log', 'v1', 'docGenerator'],

使用方法

每次您调用API的端点时，ApiDocGenerator都会尝试写入相应的Apidoc.js注释文件。如果已经生成了输出文件，它将不会被覆盖。您必须删除它并再次调用端点。

然后，您必须调用Apidoc.js来生成文档

apidoc -i <PATH_TO_YII2_APIDOC_GENERATOR_DATA_ALIAS> -o <PATH_TO_YOUR_GENERATED_DOCS>