# Api-doc 文档自动生成(针对 thinkphp5.0 / 5.1)
摘自: [https://github.com/zhangweiwei0326/api-doc](https://github.com/zhangweiwei0326/api-doc)
#api-doc
### [](https://github.com/zhangweiwei0326/api-doc#%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95)使用方法
####1、安装扩展
~~~
composer require weiwei/api-doc
~~~
####2、配置参数
* 5.0安装好扩展后在 application\\extra\\ 文件夹下会生成 doc.php 配置文件
* 5.1安装好扩展后在 application\\config\\ 文件夹下会生成 doc.php 配置文件
* 在controller参数中添加对应的类
~~~
'controller' => [
'app\\api\\controller\\Demo' //这个是控制器的命名空间+控制器名称
]
~~~
####3、在相关接口类中增加注释参数( group 参数将接口分组,可选)
* 方法如下:返回参数支持数组及多维数组
~~~
namespace app\index\controller;
use think\Controller;
/**
* @title 测试demo
* @description 接口说明
* @group 接口分组