itxq / api-doc-php
api-doc-php
Installs: 895
Dependents: 0
Suggesters: 0
Security: 0
Stars: 16
Watchers: 2
Forks: 8
Open Issues: 0
Language:HTML
Requires
- php: >=5.6.0
This package is auto-updated.
Last update: 2024-03-22 00:59:56 UTC
README
主要功能：
- 根据接口注释自动生成接口文档
演示地址
【Gitee Pages:】http://itxq.gitee.io/api-doc-php
开源地址：
【GigHub:】https://github.com/itxq/api-doc-php
【码云:】https://gitee.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);