PHPackages                             weiwei/api-doc - 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. weiwei/api-doc

ActiveThink-extend[API Development](/categories/api)

weiwei/api-doc
==============

The ThinkPHP6 Api Doc Package

1.7.1(5y ago)10710.2k41[9 issues](https://github.com/zhangweiwei0326/api-doc/issues)MITPHP

Since Jun 1Pushed 3y ago4 watchersCompare

[ Source](https://github.com/zhangweiwei0326/api-doc)[ Packagist](https://packagist.org/packages/weiwei/api-doc)[ RSS](/packages/weiwei-api-doc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (6)Used By (0)

\#api-doc

### 使用方法

[](#使用方法)

\####1、安装扩展

```
- 6.0执行 1.7开始只支持tp6
composer require weiwei/api-doc
- 5.0或者5.1
composer require weiwei/api-doc 1.6.2

```

\####2、配置参数

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

```
    'controller' => [
        'app\\api\\controller\\Demo' //这个是控制器的命名空间+控制器名称
    ]

```

\####3、在相关接口类中增加注释参数( group 参数将接口分组，可选)

- 方法如下：返回参数支持数组及多维数组

```