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

ActiveThink-extend

misscx/api-doc
==============

基于ThinkPHP6的API注释文档生成扩展

1.0.2(5y ago)4336MITHTMLPHP >=7.1.0

Since Jul 18Pushed 2y ago1 watchersCompare

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

READMEChangelog (4)Dependencies (3)Versions (4)Used By (0)

api-doc
=======

[](#api-doc)

### 使用方法

[](#使用方法)

#### 1、安装扩展

[](#1安装扩展)

```
composer require misscx/api-doc

```

#### 2、静态资源复制

[](#2静态资源复制)

- 将本插件目录src/apidoc复制到的到网站静态资源目录内，如将apidoc目录复制到网站根目录的/static下，目录结构如下： /static/apidoc

#### 3、配置参数

[](#3配置参数)

安装好扩展后在 app\\config\\ 文件夹下会生成 doc.php 配置文件，打开配置文件修改如下内容：

- 修改静态资源所在位置

```
'static_path' => '/static/apidoc',//静态资源所在位置

```

- 在controller参数中添加需要生成文档的类

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

```

- 配置路由 将本扩展src目录内route文件夹中的路由配置文件doc.php复制到路由目录内，如：/route/doc.php。

#### 4、注释举例

[](#4注释举例)

- 插件目录下有个Demo.php，可将其放入app/controller/下,单应用模式下有效，对于多应用模式，请根Demo.php进行修改。
- Demo.php文件如下：返回参数支持数组及多维数组

```