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

ActiveLibrary[API Development](/categories/api)

xianrenqh/api-doc-php
=====================

api-doc-php

1.4.4(5y ago)1171Apache-2.0PHPPHP >=5.6.0

Since Jul 24Pushed 5y agoCompare

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

READMEChangelog (5)DependenciesVersions (8)Used By (1)

Api-Doc-PHP
===========

[](#api-doc-php)

\###说明： 此代码拷贝于IT小强的源码，开源git地址：

修改部分代码，并增加tp使用注释。 如喜欢原版请使用IT小强的git

\###版本更新： 1.4.3 修复注释间多个空格bug
1.4.1 调整json代码块颜色 1.4.0 新增输出返回json数据 1.3.0 新增header参数 1.2.0 优化原版本

### 主要功能：

[](#主要功能)

- 根据接口注释自动生成接口文档

### 演示地址

[](#演示地址)

[【Gitee Pages:】http://itxq.gitee.io/api-doc-php](http://itxq.gitee.io/api-doc-php)

### 开源地址：

[](#开源地址)

[【GigHub:】https://github.com/xianrenqh/api-doc-php](https://github.com/xianrenqh/api-doc-php)

### 扩展安装：

[](#扩展安装)

- 方法一：composer命令 `composer require xianrenqh/api-doc-php`
- 方法二：直接下载压缩包，然后进入项目中执行 composer命令 `composer update` 来生成自动加载文件

### 引用扩展：

[](#引用扩展)

- 当你的项目不支持composer自动加载时，可以使用以下方式来引用该扩展包

```
// 引入扩展（具体路径请根据你的目录结构自行修改）
require_once __DIR__ . '/vendor/autoload.php';

```

### 使用扩展：

[](#使用扩展)

```
// 引入扩展（具体路径请根据你的目录结构自行修改）
require_once __DIR__ . '/../vendor/autoload.php';
// 加载测试API类1
require_once __DIR__ . '/Api.php';
// 加载测试API类2
require_once __DIR__ . '/Api2.php';
$config = [
    'class'         => ['Api', 'Api2'], // 要生成文档的类
    'filter_method' => ['__construct'], // 要过滤的方法名称
];
$api = new \xianrenqh\apidoc\BootstrapApiDoc($config);
$doc = $api->getHtml();
exit($doc);

```

### thinkphp5.1使用方法：

[](#thinkphp51使用方法)

1、在控制器下面可以创建例如： application/index/controller/Doc.php

文档代码为：

```