PHPackages                             landrain/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. landrain/yii2-apidoc

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

landrain/yii2-apidoc
====================

yii2 api doc by php exlanatory note

v1.0.2(7y ago)997HTML

Since Jan 16Pushed 7y ago1 watchersCompare

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

READMEChangelogDependencies (1)Versions (6)Used By (0)

项目描述
----

[](#项目描述)

```
1、规范API接口的注释。注释即文档，注释结构不对无法渲染出页面，更无法与对接方交流

2、节省前后端文档定义和书写。文档按照基本格式输出，该有的元素都存在，极大的减少前后端交流成本。

3、文档注释方便。配合phpstrom的自定制注释输出，不需要花费额外时间背文档特殊定义词汇。

```

安装
--

[](#安装)

composer require landrain/yii2-apidoc

访问
--

[](#访问)

直接访问项目地址根目录即可。登录默认密码：123456

准备
--

[](#准备)

1、请确保yii2开启了url美化功能，

```
'urlManager' => [
    'enablePrettyUrl' => true,
    'showScriptName' => false,
    'rules' => [
    ],
],
```

2、本项目是以module模块的接口开发为基础，请确定项目下有modules模块 3、本项目暂时仅用于yii2-basic项目，暂不适用于yii2高级版

项目配置：
-----

[](#项目配置)

将下方配置引入入口文件web/index-dev.php或web/index-test.php( 正式环境不要引入）：

```
$config['modules']['jid'] = [
    'class'=>'landrain\apidoc\Module', //v1.0.2版本前为 landrain\Module
    'name'=>'接口调试系统',
    'password'=>'123456',
    'ipFilters'=>['*','::1'],
    'language' => 'zh',
    'loginConfig'=>[
        'loginUrl' => '/sail/seller/login',
        'fieldMapping'=>[
            'account'=>'domain',
            'password'=>'password',
        ],
    ],
    'subOfClasses' => [], //需要继承的classes
    'dropdownList' => [
    "android下载" => "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1547463466873&di=3e5a65b07a4dddf84fce5f421f0b64ca&imgtype=0&src=http%3A%2F%2Fy3.ifengimg.com%2Fnews_spider%2Fdci_2013%2F09%2Fb85234c4801f8b2d7771353867a7a0f8.jpg"
    ], //右上角下拉image
    'xhprofUrl' => 'http://192.168.1.254:8888/xhprof_html/index.php', //xhprofUrl链接
];

$config['defaultRoute']  = 'jid';
if(isset($_REQUEST['xhprof']) && $_REQUEST['xhprof'] == 1){
    xhprof_enable(XHPROF_FLAGS_CPU+XHPROF_FLAGS_MEMORY);
}
```

### \['modules'\]\['jid'\]配置说明：

[](#modulesjid配置说明)

注释参数作用备注class模块入口name模块名称，将会显示在页面password登录模块的密码ipFiltersIP登录限制language语言选择简单支持en/zhloginUrl登录地址项目中的登录地址fieldMapping登录参数名和显示名称subOfClasses需要继承的指定class,若为空则将所有controller囊括，否则必须继承这些类才会显示在页面上dropdownList显示在右上角的图片，一般用作下载二维码格式为：显示名称:图片地址xhprofUrlxhprof的配置地址Phpstrom 注释配置：
--------------

[](#phpstrom-注释配置)

打开phpstrom->setting->Editor->File and Code Templates->Includes，将两个文件内容替换原本的文件内容,点击apply即可

### 配置文件：

[](#配置文件)

PHP Function Doc Comment

```
/**
#if (${NAME.indexOf('action')} != '-1' && ${NAME}!='actions')
@brief 接口名称
@param type $name this is your test name (=name:defaultValue=)
@method POST/GET
@detail 接口描述
@return array
@throws Null
#end
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
*/

```

PHP Class Doc Comment

```
/**
 * Class ${NAME}
#if (${NAMESPACE}) * @package ${NAMESPACE}
#end
#if ('Module' == ${NAME})
@jid-enable
@jid-name 模块名称
@jid-id 模块ID
#elseif (${NAME.indexOf('Controller')}!=-1)
@brief controller名称
#end
 */

```

检查phpstorm配置
------------

[](#检查phpstorm配置)

在SiteController或任意controller文件上，输入/\*\* 后输入enter键，将会输出注释 [演示图片](https://jsinchina.oss-cn-qingdao.aliyuncs.com/flash/index.gif)

使用jid编写程序注释
-----------

[](#使用jid编写程序注释)

1、检索项目第一级目录下的Modules模块下所有Module.php文件，注释参数如下：

注释参数作用备注jid-enable标明此module将被收录到文档中jid-idid值jid-name模块名称，将显示在页面上方2、检索modules具体模块下controllers文件夹下所有controller文件，并遍历所有controller文件中所有action开头的所有方法，方法注释规范如下：

注释参数作用备注brief标明方法名称，将会显示在页面左方param需要传入的参数，将会动态添加到页面from表单中string(类型) $name(参数) 这是一个人的姓名(注释) (=姓名:张三=)method调用方法，POST/GETreturn返回参数，将会显示在页面右方throws异常声明，将会显示在页面右方detail接口说明，将会显示在页面右方示例：
---

[](#示例)

先配置好phpstome注释配置。 1、配置modules模块注释 2、配置controller类的注释 3、配置action的注释

[测试项目源码地址](https://github.com/FlyLand/yii2-apidoc-basic-test)[测试项目访问地址](http://api.storecardhome.cn) 默认密码：123456

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity64

Established project with proven stability

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 ~17 days

Total

3

Last Release

2639d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b208a04ce98be33a1d223fd9885d606786f768b5bb4dfa8645da676faa59b507?d=identicon)[landrain](/maintainers/landrain)

---

Tags

yii2yii2-apidocapiyii2php exlanatory

### Embed Badge

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

```
[![Health](https://phpackages.com/badges/landrain-yii2-apidoc/health.svg)](https://phpackages.com/packages/landrain-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)