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

ActiveLibrary[API Development](/categories/api)

itxq/api-doc-php
================

api-doc-php

v1.1.1(7y ago)151.0k81Apache-2.0HTMLPHP >=5.6.0

Since Jun 6Pushed 7y ago1 watchersCompare

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

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

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

[](#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`查看

[](#具体效果可运行test目录下的indexphp查看)

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity26

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Total

5

Last Release

2886d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/928b5ea53fa9cd97dfbdd2a8a5de5020a94722939884a749bda9421a19894c02?d=identicon)[IT小强xqitw.cn](/maintainers/IT%E5%B0%8F%E5%BC%BAxqitw.cn)

---

Top Contributors

[![itxq](https://avatars.githubusercontent.com/u/17096065?v=4)](https://github.com/itxq "itxq (30 commits)")

---

Tags

apidocphp

### Embed Badge

![Health badge](/badges/itxq-api-doc-php/health.svg)

```
[![Health](https://phpackages.com/badges/itxq-api-doc-php/health.svg)](https://phpackages.com/packages/itxq-api-doc-php)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

74513.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

265103.1M454](/packages/google-gax)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)