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

ActiveLibrary[API Development](/categories/api)

phpwdk/api-doc-php
==================

api-doc-php

061PHP

Since Apr 30Pushed 5y ago1 watchersCompare

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

READMEChangelogDependenciesVersions (1)Used By (0)

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

[](#api-doc-php)

### 主要功能：

[](#主要功能)

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

### 开源地址：

[](#开源地址)

### 扩展安装：

[](#扩展安装)

- 方法一：composer命令 `composer require phpwdk/api-doc-php`
- 方法二：直接下载压缩包，然后进入项目中执行 composer命令 `composer update` 来生成自动加载文件

### 引用扩展：

[](#引用扩展)

- 当你的项目不支持composer自动加载时，可以使用以下方式来引用该扩展包

```
// 引入扩展（具体路径请根据你的目录结构自行修改）
require_once __DIR__ . '/vendor/autoload.php';

```

### 使用扩展：

[](#使用扩展)

```
// 引入扩展（具体路径请根据你的目录结构自行修改）
require_once __DIR__ . '/../vendor/autoload.php';
// 加载测试API类
require_once __DIR__ . '/Api.php';
$config = [
    'class'         => ['Api'], // 要生成文档的类
    'filter_method' => ['__construct'], // 要过滤的方法名称
];
$api = new \phpwdk\apidoc\BootstrapApiDoc($config);
$doc = $api->getHtml();
exit($doc);

```

```
/**
 * @title 用户登录API
 * @url https://wwww.baidu.com/login
 * @method POST
 * @param string username 是 账号 无 无 账户登陆信息
 * @param string password 是 密码 无 无 账户登陆信息
 * @code 1 成功
 * @code 2 失败
 * @desc_return int code 是 状态码（具体参见状态码说明） 无 无
 * @desc_return string msg 是 提示信息 无 无
 */

 行说明：
 1、操作类型
 2、字段类型
 3、字段名称
 4、是否必填
 5、字段标题
 6、上级字段
 7、默 认 值
 8、文本介绍

```

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

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

###  Health Score

17

—

LowBetter than 6% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity30

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/28852819?v=4)[phpwdk](/maintainers/phpwdk)[@phpwdk](https://github.com/phpwdk)

---

Top Contributors

[![phpwdk](https://avatars.githubusercontent.com/u/28852819?v=4)](https://github.com/phpwdk "phpwdk (38 commits)")

### Embed Badge

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

```
[![Health](https://phpackages.com/badges/phpwdk-api-doc-php/health.svg)](https://phpackages.com/packages/phpwdk-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)