PHPackages                             tiacx/laravel-apifox - 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. tiacx/laravel-apifox

ActiveLibrary[API Development](/categories/api)

tiacx/laravel-apifox
====================

Laravel-ApiFox

1.0.4(4mo ago)11.4k↓33.3%MITPHPPHP >=7.0.0

Since Nov 8Pushed 4mo ago1 watchersCompare

[ Source](https://github.com/Tiacx/Laravel-ApiFox)[ Packagist](https://packagist.org/packages/tiacx/laravel-apifox)[ RSS](/packages/tiacx-laravel-apifox/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (2)Versions (9)Used By (0)

Laravel-ApiFox
==============

[](#laravel-apifox)

说明
--

[](#说明)

功能：通过`TestCase`快速生成`ApiFox`文档

安装
--

[](#安装)

```
composer require tiacx/laravel-apifox --dev
```

配置
--

[](#配置)

发布配置文件

```
php artisan vendor:publish --tag=config
```

配置请求中间件

> 修改 `app/Http/Kernel.php` 文件，增加 `\Tiacx\ApiFox\Middleware\ApiFoxMiddleware::class` 中间件配置

增加 `.env` 配置项

```
APIFOX_PROJECT_ID=3481718
APIFOX_ACCESS_TOKEN=APS-8YGmxRP5V3w5dWER6WEXXXXXXXXXX
```

注：项目ID 及 访问令牌的获取方法请参考官方开放平台说明（[https://apifox-openapi.apifox.cn/）](https://apifox-openapi.apifox.cn/%EF%BC%89)

使用
--

[](#使用)

在 `TestCase` 方法处添加 `@apifox.name` 及 `@apifox.tags` 标识，然后运行 `TestCase` 即可。

- `@apifox.name` 接口名称（必填）
- `@apifox.description` 接口描述（非必填）
- `@apifox.dirs` 接口目录（非必填。支持多级，使用 `/` 隔开）
- `@apifox.tags` 接口标签（非必填。支持多级，使用 `/` 隔开）
- `@apifox.withHeaders` 带上头信息（非必填。公共头应该在 `ApiFox` 里设置）

```