PHPackages                             jkluo/lumen-auto-apidoc - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. jkluo/lumen-auto-apidoc

ActiveLibrary[API Development](/categories/api)

jkluo/lumen-auto-apidoc
=======================

The Lumen Api Auto Testing

2.0.x-dev(5y ago)05MITPHPPHP >=5.6.0

Since Feb 17Pushed 3y ago1 watchersCompare

[ Source](https://github.com/jkluo/lumen-auto-apidoc)[ Packagist](https://packagist.org/packages/jkluo/lumen-auto-apidoc)[ RSS](/packages/jkluo-lumen-auto-apidoc/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (1)DependenciesVersions (2)Used By (0)

Lumen-auto-apidoc
=================

[](#lumen-auto-apidoc)

Lumen auto apidoc && testing just like swagger

### 使用方法

[](#使用方法)

#### 1、安装扩展

[](#1安装扩展)

```
composer  require jkluo/lumen-auto-apidoc
```

#### 2、注册服务提供者

[](#2注册服务提供者)

```
    添加（可区分evn） $app->register(Jkluo\LumenApiDoc\ApiDocServiceProvider::class);到bootstrap/app.php
```

#### 3、复制前端资源文件及配置文件

[](#3复制前端资源文件及配置文件)

```
   1.复制插件目录下面的lumen-auto-apidoc\assets里面的文件到(public|www)/apidoc文件下
   2.复制插件目录下面的lumen-auto-apidoc\src\config\doc.php文件到config\doc.php,没有config目录自己创建一个
```

#### 4、在config/doc.php文件中，配置需要生成文档的接口类

[](#4在configdocphp文件中配置需要生成文档的接口类)

```
return [
    'title' => "APi接口文档",  //文档title
    'version'=>'1.0.0', //文档版本
    'copyright'=>'Powered By Jkluo', //版权信息
    'controller' => [
        //需要生成文档的类
	'App\\Http\\Controllers\\Api\\DemoController'//此控制器demo文件请看下一个步凑中的源码，或者在包根目录下面DemoController.php
    ],
    'filter_method' => [
        //过滤 不解析的方法名称
        '_empty'
    ],
    'return_format' => [
        //数据格式
        'status' => "200/300/301/302",
        'message' => "提示信息",
    ],
    'public_header' => [
        //全局公共头部参数
        //如：['name'=>'version', 'require'=>1, 'default'=>'', 'desc'=>'版本号(全局)']
    ],
    'public_param' => [
        //全局公共请求参数，设置了所以的接口会自动增加次参数
        //如：['name'=>'token', 'type'=>'string', 'require'=>1, 'default'=>'', 'other'=>'' ,'desc'=>'验证（全局）')']
    ],
];
```

#### 5、在相关接口类中增加注释参数( group 参数将接口分组，可选。param 参数格式为 Validate)

[](#5在相关接口类中增加注释参数-group-参数将接口分组可选param-参数格式为-validate)

方法如下：返回参数支持数组及多维数组，Validate 规则详见

##### 1、重写父类validate方法

[](#1重写父类validate方法)

```