5 Star 15 Fork 7

IT小强xqitw.cn / api-doc-php

Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
Clone or Download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

Api-Doc-PHP

主要功能:

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

演示地址

【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查看

Repository Comments ( 2 )

Sign in to post a comment

About

根据接口注释自动生成接口文档 expand collapse
Cancel

Releases (4)

All

Contributors

All

Activities

Load More
can not load any more
1
https://gitee.com/itxq/api-doc-php.git
git@gitee.com:itxq/api-doc-php.git
itxq
api-doc-php
api-doc-php
master

Search

182229 41614e54 1850385 182230 7885ed45 1850385