ibunao/yii2-apidoc

There is no license information available for the latest version (v0.0.5) of this package.

apidoc for yii

v0.0.5 2019-04-30 01:28 UTC

README

安装

composer require ibunao/yii2-apidoc

配置

配置到模块数组

假设我们要放到 backend 项目下

'modules' => [
    ...
    ...
    'document' => [
        'class' => 'ibunao\apidoc\Module',
        # 配置访问接口的host  通常配置 frontend 项目的域名
        'debugHost' => 'http://api.yiidoc.com',
        # 和配置时定义的模块名一致
        'moduleName' => 'document',
    ],
    ...
    ...
],

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

return [
	'apiList' => [
		'test' => [
			'label' => '文档测试',
			'class' => 'frontend\controllers\ApidocController',
		],
		'test2' => [
			'label' => '文档测试2',
			'class' => 'frontend\controllers\Apidoc2Controller',
		],
	],
];

表和静态资源

剩下的需要设置的就是创建一个表用来存储文档编辑部分数据,还有就是将静态资源放到指定位置。相关文件放在 vendor\ibunao\yii2-apidoc\source

  1. 需要创建表的sql看 document_api.sql 文件
  2. 以配在 backend 项目为例,把 cssjs 文件夹放在 backend\web

为什么不用资源发布和数据库迁移?
不想费劲

生成文档的备注格式

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

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

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

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

@author表示接口作者/负责人,可空

/**
 * 注册步骤一:手机号获取验证码
 *
 * @name	获取注册验证码
 * @uses	用户注册是拉取验证码
 * @method	post
 * @param	string $phone 手机号
 * @author	echoding
 */
public function actionIndex()
{
    Yii::$app->response->format = 'json';
	return Yii::$app->request->post();
}

apidoc4

示例

首页

apidoc3

可以编辑文档说明和示例

apidoc5

接口调试

apidoc6