## 文档平台
[http://d.magcloud.net](http://d.magcloud.net)
1. 现在文档平台注册用户
2. 点击右上角头像,在弹出的用户页面可以查看用户密钥
3. 创建对应文档
## 安装
compose 安装
[ly\_lib/api-doc](http://package.magcloud.net/#ly_lib/api-doc)
## 使用
第一次使用时执行,会生成配置文件
```
php index.php api_doc
```
生成 的文件 为 app/api_doc_config.php
内容如下
~~~
<?php
return ["api" => ['type' => 'api',
'book_id' => '',
'user_id' => '',
'url' => 'http://d.magcloud.net',
'api_secret' => '用户密钥',
'classes' => [ ]]
];
~~~
### 分组
return 的是个数组键为名称,可以创建多组
~~~
<?php
return ["api" => [....],"service"=>[....]];
~~~
### 文档类型
type 表示文档类型,目前支持两种类型
1. api 会自定产生接口文档
2. service 会产生对应类的说明文档
### 完整例子
~~~
<?php
return ["api" => ['type' => 'api',
'book_id' => '30',
'user_id' => '7',
'url' => 'http://d.magcloud.net',
'api_secret' => '0bf9d50xxxx075c4efe6',
'classes' => [\app\controller\api\v1\OpenController::class,
\app\controller\api\v1\UserController::class,
\app\controller\open\v1\UtilsController::class,
\app\controller\open\v1\UploadController::class
],],
"admin" => ['type' => 'api',
'book_id' => '30',
'user_id' => '7',
'url' => 'http://d.magcloud.net',
'api_secret' => '0bf9d50xxxx075c4efe6',
'classes' => [\app\controller\admin\v1\AdminUserController::class,\app\controller\admin\v1\RoleController::class],],
"service" => ['type' => 'service',
'book_id' => '30',
'user_id' => '7',
'url' => 'http://d.magcloud.net',
'api_secret' => '0bf9d50xxxx075c4efe6',
'classes' => [\ly_lib\user_center\IUserService::class,\ly_lib\user_center\UserCenter::class],],
];
~~~
