PHPackages                             klightsaber/yii2-doc-online - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. klightsaber/yii2-doc-online

ActiveLibrary[Utility & Helpers](/categories/utility)

klightsaber/yii2-doc-online
===========================

A online document library used by Yii2 framework.

v2.0.2(7y ago)08MITPHP

Since Jul 24Pushed 7y agoCompare

[ Source](https://github.com/klightsaber/yii2-doc-online)[ Packagist](https://packagist.org/packages/klightsaber/yii2-doc-online)[ Docs](http://www.liyangweb.com)[ RSS](/packages/klightsaber-yii2-doc-online/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (12)Used By (0)

Home page
---------

[](#home-page)

```
How to install?

composer require kaopur/yii2-doc-online

```

### How to use?

[](#how-to-use)

1. Install the library.
2. Create a new module config to web.php like this: ```
    'modules' => [
        'doconline' => [
            'class' => 'Kaopur\yii2_doc_online\Module',
            'defaultRoute' => 'index', //默认控制器
            'appControllers' => true, //是否检测app\controllers命名空间下的控制器
            'suffix' => '', //api后缀
            'prefix' => '', //api前缀
            'modules' => [  //需要生成文档的模块命名空间
                'app\modules\admin\Module',
            ],
        ],
    ],

    ```
3. Open the url from you browser. `http://url.com?r=doconline`

### Example

[](#example)

#### The code like this:

[](#the-code-like-this)

```
/**
 * 这是一个测试的Api
 * @desc 列举所有的注释格式
 * @param string $user_type |用户类型|yes|其他说明|
 * @param int $sex |性别|no|0:不限 1:男 2:女|
 * @return int status 操作码，0表示成功
 * @return array list 用户列表
 * @return int list[].id 用户ID
 * @return string list[].name 用户名字
 * @return string msg 提示信息
 * @exception 400 参数传递错误
 * @exception 500 服务器内部错误
 */
public function actionDemoapi($user_type, $sex)
{
    $result = [
        'status' => 0,
        'list' => [
            'id' => 1,
            'name' => 'kaopur'
        ],
        'msg' => 'OK'
    ];
    return \yii\helpers\Json::encode($result);
}

```

#### Show

[](#show)

[![image](https://raw.githubusercontent.com/kaopur/yii2-doc-online/master/imgs/desc_page.png)](https://raw.githubusercontent.com/kaopur/yii2-doc-online/master/imgs/desc_page.png)

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor1

Top contributor holds 87.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~46 days

Recently: every ~98 days

Total

10

Last Release

2798d ago

Major Versions

v1.0.14 → v2.0.02017-10-24

### Community

Maintainers

![](https://www.gravatar.com/avatar/2fa9d6cc15b85d2f7ea90913ce2b0c5493d45bcb4fe6c60d9ebb51e9bf398d45?d=identicon)[klightsaber](/maintainers/klightsaber)

---

Top Contributors

[![coder-liyang](https://avatars.githubusercontent.com/u/5719210?v=4)](https://github.com/coder-liyang "coder-liyang (29 commits)")[![freeng](https://avatars.githubusercontent.com/u/11569939?v=4)](https://github.com/freeng "freeng (2 commits)")[![xiaochengfu](https://avatars.githubusercontent.com/u/15496255?v=4)](https://github.com/xiaochengfu "xiaochengfu (2 commits)")

---

Tags

yii2-doc-online

### Embed Badge

![Health badge](/badges/klightsaber-yii2-doc-online/health.svg)

```
[![Health](https://phpackages.com/badges/klightsaber-yii2-doc-online/health.svg)](https://phpackages.com/packages/klightsaber-yii2-doc-online)
```

###  Alternatives

[askedio/laravel-ratchet

A Ratchet Server built for Laravel

18728.2k2](/packages/askedio-laravel-ratchet)[wdev-rs/laravel-datagrid

Laravel integration for Grid.js server side processing

548.4k](/packages/wdev-rs-laravel-datagrid)[elfsundae/laravel-gravatar

The easiest way to generate Gravatar avatar URL.

388.7k](/packages/elfsundae-laravel-gravatar)[simialbi/yii2-kanban

Kanban board module for yii2

111.1k1](/packages/simialbi-yii2-kanban)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)