PHPackages                             kedeemaul/yii2-apidoc - 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. [API Development](/categories/api)
4. /
5. kedeemaul/yii2-apidoc

ActiveYii2-extension[API Development](/categories/api)

kedeemaul/yii2-apidoc
=====================

Yii2 通过API动作方法注释，自动生成可阅读可调试的API文档

1.5(7y ago)053MITPHPPHP >=5.4.0

Since Mar 26Pushed 7y agoCompare

[ Source](https://github.com/kedeemaul/yii2-apidoc)[ Packagist](https://packagist.org/packages/kedeemaul/yii2-apidoc)[ Docs](https://github.com/kedeemaul/yii2-apidoc)[ RSS](/packages/kedeemaul-yii2-apidoc/feed)WikiDiscussions master Synced yesterday

READMEChangelog (6)Dependencies (1)Versions (7)Used By (0)

yii2-apidoc
===========

[](#yii2-apidoc)

yii2 通过API动作方法的注释，自动生成可阅读可调试的API文档

### 安装

[](#安装)

```
composer require kedeemaul/yii2-apidoc
```

### 配置

[](#配置)

#### 1、配置到模块数组

[](#1配置到模块数组)

假设我们要放到 `backend` 项目下 config/main.php的modules数组配置如下

```
'modules' => [
        'docs' => [
            'class' => 'yii2docs\apidoc\Module',
            # 和配置时定义的模块名一致
            'moduleName' => 'docs',
        ]
    ]
```

#### 2、配置需要接口文档的控制器

[](#2配置需要接口文档的控制器)

config/params.php配置如下

```
return [
    'apiList' => [
        [
            'label' => '文档测试1',//文档分组名称
            'debugHost' => 'http://apidoc.yii2.com:802',//调试api访问域名，不配置或留空，默认为当前HOST
            'class' => 'apidoc\controllers\UserController',//class为api所在的控制器
        ],
        [
            'label' => '文档测试2',//文档分组名称
            'debugHost' => 'http://admin.yii2.com:802',//调试api访问域名，不配置或留空，默认为当前HOST
            'class' => 'backend\controllers\SystemController',//class为api所在的控制器
        ],
    ],
];
```

#### 表和静态资源

[](#表和静态资源)

将静态资源放到指定位置。相关文件放在 `vendor\kedeemaul\yii2-apidoc\source`以配在 `backend` 项目为例，把 `css` 和 `js` 文件夹放在 `backend\web` 下

### 生成文档的备注格式

[](#生成文档的备注格式)

**@name表示接口名称，不注释则文档不显示该接口**

@uses 表示接口简介/用途等，可空

@method 表示请求方式，不注释默认为get

@author 作者姓名

@create 创建日期

@request 参数传递说明，如“参数名以\*号开头表示必填”

@param 表示请求参数，可多个，后面分别跟类型、参数名，备注

@response 返回内容介绍，如“返回JSON结构体，具体键值如下”

@return 表示返回内容，可多个，后面分别跟类型、返回名，备注

```
/**
* @name 获取注册验证码
* @uses 用户注册是拉取验证码
* @method get
* @author kedee
* @create 创建日期
* @request 参数传递说明，如“参数名以*号开头表示必填”
* @param string *phone 手机号
* @response 返回JSON结构体，具体键值如下
* @return int status 状态码：1正常，0错误
* @return string msg 提示消息内容
* @return array data 返回消息体数组
*/
public function actionRegGetCode($phone)
{
}
```

#### 配置phpstorm注释模版

[](#配置phpstorm注释模版)

```
/**
* @name 动作方法名称
* @uses 方法用途说明
* @method get
* @author ${DEVUSER}
* @create ${DATE} ${TIME}
* @request 参数名以*号开头表示必填
 ${PARAM_DOC}
* @param 类型 参数名 参数说明
 #if (${TYPE_HINT} != "void")
* @response ${TYPE_HINT} 返回JSON结构体，具体键值如下
* @return int status 状态码：1正常，0错误
* @return string msg 提示消息内容
* @return array data 返回消息体数组
#end
${THROWS_DOC}
 */
```

### 示例

[](#示例)

文档说明和示例

[![apidoc0](https://raw.githubusercontent.com/kedeemaul/githubs/master/apidoc0.jpg)](https://raw.githubusercontent.com/kedeemaul/githubs/master/apidoc0.jpg)

接口调试

[![apidoc1](https://raw.githubusercontent.com/kedeemaul/githubs/master/apidoc1.jpg)](https://raw.githubusercontent.com/kedeemaul/githubs/master/apidoc1.jpg)

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 64.3% 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 ~0 days

Total

6

Last Release

2604d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9cf1cf37050cd6953009a390f60f0c231b3f96483dfc0e0afa79c85ae38971b5?d=identicon)[kedeemaul1](/maintainers/kedeemaul1)

---

Top Contributors

[![ucodesonly](https://avatars.githubusercontent.com/u/263794513?v=4)](https://github.com/ucodesonly "ucodesonly (9 commits)")[![kedeemaul](https://avatars.githubusercontent.com/u/48947611?v=4)](https://github.com/kedeemaul "kedeemaul (5 commits)")

---

Tags

apiyii2apidoc

### Embed Badge

![Health badge](/badges/kedeemaul-yii2-apidoc/health.svg)

```
[![Health](https://phpackages.com/badges/kedeemaul-yii2-apidoc/health.svg)](https://phpackages.com/packages/kedeemaul-yii2-apidoc)
```

###  Alternatives

[dotzero/yii2-amocrm

Расширение для Yii Framework 2 реализующее клиент для работы с API amoCRM

1639.7k](/packages/dotzero-yii2-amocrm)[skeeks/yii2-google-api

Component for work with google api based on google/apiclient

1243.1k1](/packages/skeeks-yii2-google-api)

PHPackages © 2026

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