PHPackages                             oyhdd/laravel-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. oyhdd/laravel-apidoc

ActiveLibrary[API Development](/categories/api)

oyhdd/laravel-apidoc
====================

自动生成在线测试接口和文档

2.2.5(6y ago)8124MITHTMLCI failing

Since Sep 12Pushed 6y ago1 watchersCompare

[ Source](https://github.com/oyhdd/laravel-apidoc)[ Packagist](https://packagist.org/packages/oyhdd/laravel-apidoc)[ RSS](/packages/oyhdd-laravel-apidoc/feed)WikiDiscussions master Synced yesterday

READMEChangelog (10)Dependencies (1)Versions (22)Used By (0)

自动生成在线测试接口和文档
=============

[](#自动生成在线测试接口和文档)

[演示地址](http://121.199.40.77/document/api)

```
账号：admin  密码：123456

```

一.安装
----

[](#一安装)

### 1.在项目根目录下执行

[](#1在项目根目录下执行)

```
composer require oyhdd/laravel-apidoc

```

### 2.发布资源文件及配置文件

[](#2发布资源文件及配置文件)

```
php artisan vendor:publish --provider="Oyhdd\Document\DocumentServiceProvider"

```

注：若文件已存在，可通过以下命令强制覆盖

```
php artisan vendor:publish --provider="Oyhdd\Document\DocumentServiceProvider" --force

```

文件发布成功后，会生成配置文件config/document.php，前端资源文件resources/views/vendor/document/\* 和 public/vendor/document/\*

### 3.创建数据表

[](#3创建数据表)

```
php artisan migrate --path=./vendor/oyhdd/laravel-apidoc/src/database/migrations/

```

备注：api\_doc表存储接口相关信息，api\_doc\_params表存储接口的测试用例

### 4.访问

[](#4访问)

在浏览器打开{host}/document/api 后即可访问

二.使用方法
------

[](#二使用方法)

### 1.控制器接口函数中按如下格式进行函数注释：

[](#1控制器接口函数中按如下格式进行函数注释)

```
    /**
     * @name   测试1
     * @uses   测试接口
     * @author wangmeng
     * @date   2018-10-19
     * @header string|true               $token              header头
     * @param  string|true               $str                字符串
     * @param  int|true                  $number             数字
     * @param  array|true                $arr                数组
     * @return array
     */
    public function test(Request $request)
    {
        $ret = [
            'code' => 0,
            'msg' => 'success',
            'data' => [
                'header' => ['token' => $request->header('token')],
                'body' => $request->all(),
            ],
        ];

        return $ret;
    }
```

[![](resource/pic1.png)](resource/pic1.png)

### 2.在routes/api.php中按如下格式配置路由：

[](#2在routesapiphp中按如下格式配置路由)

```
//测试示例接口
Route::group([], function ($router) {
    // 接口组
    $router->name('测试.')->group(function ($router) {
        $router->post('test', 'Oyhdd\Document\Controllers\TestController@test');
    });
});
```

可通过name()和group()对路由接口进行菜单栏显示时分组，其中name()是对该组路由接口进行命名，若无name(),则该组下的接口都位于一级菜单中

注意：name()中字符串参数以“.”结尾，若要自定义字符，则config/document.php中的delimiter也要同步修改

### 3.config/document.php中可配置相关功能

[](#3configdocumentphp中可配置相关功能)

```