# think5-apidoc

**Repository Path**: diycp/think5-apidoc

## Basic Information

- **Project Name**: think5-apidoc
- **Description**: ThinkPHP5 API自动生成 layui美化
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 41
- **Created**: 2018-09-18
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 龙Api 文档管理
### ThinkPHP5 API自动生成 layui美化

### 使用方法
####1、安装扩展
```
composer require okcoder/think5-apidoc
```

####2、配置参数
- 5.0安装好扩展后在 application\extra\ 文件夹下会生成 doc.php 配置文件
- 5.1安装好扩展后在 application\config\ 文件夹下会生成 doc.php 配置文件
- 在controller参数中添加对应的类

```
    'controller' => [
        [
            'name'=>'v2',
            'list'=>[
                'index\controller\v2\Demo', //控制器的命名空间+控制器名称(不需要加\\app)
                'index\controller\v2\Demo', //支持两层控制器URL自动生成
                'index\controller\v2\Demo'
            ]
        ],
        [
            'name'=>'v3版本',
            'list'=>[
                'index\controller\v3\Demo', //控制器的命名空间+控制器名称(不需要加\\app)
                'index\controller\v3\\Demo', //支持两层控制器URL自动生成
                'index\controller\v3\\Demo'
            ]
        ]
    ]
```
####3、书写规范

- 请参考Demo.php文件


####4、访问方法
- http://你的域名/doc 或者 http://你的域名/index.php/doc 

####5、预览
![](https://gitee.com/uploads/images/2018/0623/112906_e31b8f7f_696921.png "1.png")
![](https://gitee.com/uploads/images/2018/0623/112915_017f26b9_696921.png "2.png")

### 技术支持

- 素材龙 [https://sucailong.com](https://sucailong.com)
- 开发交流 [https://sucailong.com/forums](https://sucailong.com/forums)
- 整站源码 [https://sucailong.com/sources](https://sucailong.com/sources)
- 网站模板 [https://sucailong.com/templates](https://sucailong.com/templates)

### 赞助二维码

![](https://gitee.com/uploads/images/2018/0623/112959_9f84f1f7_696921.png "3.png")
![](https://gitee.com/uploads/images/2018/0623/113008_0014aa83_696921.jpeg "4.jpg")



### 问题汇总
- 无法生成自定义路由


### 更新日志
#### 2018年9月14日
- 新增多版本切换;
- 左侧菜单UI优化;
- 返回码与说明优化等


#### 2018年7月16日
- 修复dot红点bug

#### 2018年7月3日
- 支持二层控制器URL自动生成
- 新增ajax在线调试错误页面

#### 2018年7月2日
- 删除首页直接定位到说明页面

#### 2018年6月28日
- 在线调试接口从PHP的CURL改为ajax

#### 2018年6月28日
- 新增参数 dot
- 新增在线调试功能

#### 2018年6月27日
- 修改命名空间
- 优化QQ咨询弹窗

#### 2018年6月26日
- 新增咨询QQ
- 新增humpToLine驼峰转下划线,修复自动生成URL错误问题

#### 2018年6月25日
- 优化header/param/return表没有数据不显示问题
- 新增序言文档
- UI优化

#### 2018年6月22日
- 正式发布