https://github.com/itxq/api-doc-php
根据接口注释自动生成接口文档
https://github.com/itxq/api-doc-php
api doc php
Last synced: 10 months ago
JSON representation
根据接口注释自动生成接口文档
- Host: GitHub
- URL: https://github.com/itxq/api-doc-php
- Owner: itxq
- License: apache-2.0
- Created: 2018-06-06T02:53:46.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-12T07:38:39.000Z (almost 8 years ago)
- Last Synced: 2025-07-25T08:51:41.952Z (11 months ago)
- Topics: api, doc, php
- Language: HTML
- Homepage: https://www.xqitw.cn
- Size: 159 KB
- Stars: 15
- Watchers: 1
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Api-Doc-PHP
### 主要功能：
+ 根据接口注释自动生成接口文档
### 演示地址
[【Gitee Pages:】http://itxq.gitee.io/api-doc-php](http://itxq.gitee.io/api-doc-php)
### 开源地址：
[【GigHub:】https://github.com/itxq/api-doc-php](https://github.com/itxq/api-doc-php)
[【码云:】https://gitee.com/itxq/api-doc-php](https://github.com/itxq/api-doc-php)
### 扩展安装：
+ 方法一：composer命令 `composer require itxq/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 \itxq\apidoc\BootstrapApiDoc($config);
$doc = $api->getHtml();
exit($doc);
```
### 具体效果可运行test目录下的`index.php`查看