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

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

hao/api-doc
===========

thinkphp5 api-doc

2.03(7y ago)2145MITPHP

Since May 8Pushed 7y agoCompare

[ Source](https://github.com/JZhao1020/api-doc)[ Packagist](https://packagist.org/packages/hao/api-doc)[ Docs](https://github.com/JZhao1020/api-doc)[ RSS](/packages/hao-api-doc/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (10)Dependencies (2)Versions (12)Used By (0)

api-doc
=======

[](#api-doc)

### 开源地址

[](#开源地址)

1.安装
----

[](#1安装)

```
// 使用composer安装
composer require hao/api-doc
```

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

```
    'controller' => [
        'app\\api\\controller\\Demo'
    ]

```

\####3、在相关接口类中增加注释参数( group 参数将接口分组，可选) 方法如下：返回参数支持数组及多维数组（参考test文件夹中的Index.php文件）

### 接口备注示例

[](#接口备注示例)

返回数据格式，仅支持json数据格式

```