PHPackages                             mumbaicat/makeapidoc - 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. mumbaicat/makeapidoc

ActiveLibrary[API Development](/categories/api)

mumbaicat/makeapidoc
====================

注释自动生成API文档

1.31(8y ago)6897524[6 issues](https://github.com/mumbaicat/makeapidoc/issues)MITHTMLPHP >=5.3.0

Since Jan 16Pushed 7y ago2 watchersCompare

[ Source](https://github.com/mumbaicat/makeapidoc)[ Packagist](https://packagist.org/packages/mumbaicat/makeapidoc)[ Docs](https://github.com/mumbaicat/makeapidoc)[ RSS](/packages/mumbaicat-makeapidoc/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (4)DependenciesVersions (5)Used By (0)

php注释自动生成api文档 v1.7
===================

[](#php注释自动生成api文档---v17)

作者: [Dust](http://dust101.lofter.com)
-------------------------------------

[](#作者-dust)

```
composer require mumbaicat/makeapidoc

```

注释示例:
-----

[](#注释示例)

```
与普通注释互不影响，带有 @method 和 @url 的才会生成
注释中备注不要有空格，建议使用标点符号来断句。

```

```
    /**
     * 获取所有列表
     * @url api.php/index/index/all
     * @method POST
     * @param integer $page 页数
     * @param integer $limit 每页个数
     * @return integer $code 状态码
     * @return string $msg 返回消息
     */
    public function all($page,$limit){
    	// 地址中有三个占位符写法
    	// {url}/api.php/index/{controller}/{action}
        // {url} 会自动替换成设置的域名 $doc->url = 'xxx'; 来设置。
    	// {action} 会自动换成对应的方法名
    	// {controller} 会自动换成文件名(大驼峰会转成匈牙利)。
    	// --------------------------------
    	// 默认是文件名和方法名都开启大驼峰转换
    	// 文件名是大写字母出现1次以及以上就转换
    	// 方法名是大写字母出现2次以及以上就转换
        // 可以通过下面方法去改变,参数1是文件名,参数2是方法名
	    // $doc->setChange(true,true);
	    // $doc->setTime(1,2);
    }

    /**
     * 获取我的列表
     * @url api.php/index/index/my_list
     * @method GET
     * @return json json {'code':200,'msg':'json示例'}
     */
    public function my_list($page,$limit){
    	.....
    }

    /**
     * 获取我的名称
     * @url api.php/index/index/get_my_name
     * @method GET
     * @return string 名称
     */
    public function get_my_name(){
    	.....
    }

    /**
     * 添加数据
     * @url api.php/index/index/insert
     * @method GET
     * @param string $name 姓名
     * @param string $age 年龄
     * @return inetger $code 状态码
     */
    public function insert(){
    	.....
    }

```

如何使用
----

[](#如何使用)

### 1.放置文件

[](#1放置文件)

```
如果你是Thinkphp5，则将 extend 目录里的 mumbaicat 放在 TP5 的 extend 目录下 。

```

### 2.引入

[](#2引入)

```
use mumbaicat\makeapidoc\ApiDoc;

```

### 3.在合适地方实例化

[](#3在合适地方实例化)

```
$doc = new ApiDoc('../application');
// 参数1是代码目录，参数2是保存路径，参数2默认是当前路径。 注意斜杠,windows是/ ，Linux/Mac是\ ，建议使用PHP常常量 DIRECTORY_SEPARATOR
echo $doc->make();

```

将来版本:
-----

[](#将来版本)

- 等待您的提议
- ...

截图:
---

[](#截图)

[![效果](https://github.com/mumbaicat/makeapidoc/raw/master/screenshot/html.png)](https://github.com/mumbaicat/makeapidoc/raw/master/screenshot/html.png)

###  Health Score

34

↑

LowBetter than 77% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity30

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity61

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 ~59 days

Total

4

Last Release

2860d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/0e303490e9e8b627db0955647f2d3b0e6b02c19aefe2187c2e5f0b81d14bcf51?d=identicon)[mumbaicat](/maintainers/mumbaicat)

---

Top Contributors

[![mumbaicat](https://avatars.githubusercontent.com/u/34854619?v=4)](https://github.com/mumbaicat "mumbaicat (27 commits)")

---

Tags

apidocsphpphp-apiphpapi

### Embed Badge

![Health badge](/badges/mumbaicat-makeapidoc/health.svg)

```
[![Health](https://phpackages.com/badges/mumbaicat-makeapidoc/health.svg)](https://phpackages.com/packages/mumbaicat-makeapidoc)
```

###  Alternatives

[jstolpe/instagram-graph-api-php-sdk

Instagram Graph API PHP SDK

13998.4k2](/packages/jstolpe-instagram-graph-api-php-sdk)

PHPackages © 2026

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