定制 itxq/api-doc-php 二次开发

按需修改功能、优化性能、对接业务系统,提供一站式技术支持

邮箱:yvsm@zunyunkeji.com | QQ:316430983 | 微信:yvsm316

itxq/api-doc-php

最新稳定版本:v1.1.1

Composer 安装命令:

composer require itxq/api-doc-php

包简介

api-doc-php

README 文档

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);

具体效果可运行test目录下的index.php查看

统计信息

  • 总下载量: 981
  • 月度下载量: 0
  • 日度下载量: 0
  • 收藏数: 15
  • 点击次数: 1
  • 依赖项目数: 1
  • 推荐数: 0

GitHub 信息

  • Stars: 15
  • Watchers: 1
  • Forks: 8
  • 开发语言: HTML

其他信息

  • 授权协议: Apache-2.0
  • 更新时间: 2018-06-06