yii2-apidoc扩展生成API文档

一、安装或更新yii2-apidoc

安装：

composer.json文件加入以下命令：

"yiisoft/yii2-apidoc": "~2.1.0"

执行composer update命令

更新：

二、编写测试接口

创建/backend/controllers/TestController.php：

    * @since 0.1
    */
class TestController extends Controller
{
	/**
     * 注册用户
     *
     * @param string $signature hash生成的密钥
     * @param string $app_id application id
     * @param string $email 邮件地址
     * @param string $firstname 姓名
     * @param string $lastname 姓名
     * @param string $oauth_token token
     * @param string $source 来源
     * @return string $signature signature签名
     */
	public function actionRegister($signature,$app_id='',$email='',$firstname ='',$lastname='',$oauth_token='',$source='') {
		return $signature;
	}
    /**
	 * @param string $signature app_secret
	 * @param string $app_id application id
	 * @param string $email email address
	 * @param string $firstname first name
	 * @param string $lastname last name
	 */

	public function actionTest($signature,$app_id='',$email='',$firstname ='',
    $lastname='',$oauth_token='',$source='') {return $app_id;}

	
}

三、执行命令生成API

Linux下项目根目录直接执行：

./vendor/bin/apidoc api ./backend ./output   --pageTitle=MeetingPlanner

windows需要进入到/vendor/bin目录下执行：

api：可以改成guide，生成手册

./backend：需要生成API的类文件，通常是controllers里的控制器类

./output：生成后的API文档的存放地址，随意

帮助命令：

apidoc help

apidoc help api等

 

效果：

 

后续。。。。