PHPackages                             cathy/apidoc - 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. cathy/apidoc

ActiveLibrary[API Development](/categories/api)

cathy/apidoc
============

根据注解生成API文档，兼容Laravel、ThinkPHP、Hyperf、Webman等框架；在线调试、Markdown文档、多应用/多版本、Mock数据、授权访问、接口生成器、代码生成器等众多实用功能

07PHP

Since Apr 21Pushed 2y agoCompare

[ Source](https://github.com/qq1574829575/apidoc-php)[ Packagist](https://packagist.org/packages/cathy/apidoc)[ RSS](/packages/cathy-apidoc/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

 [![](https://camo.githubusercontent.com/268df3a46dcee0ecf23a93d496d5be0e862c3026fc70d8ef77c2ec55d3af528f/68747470733a2f2f646f63732e617069646f632e6963752f6c6f676f2e706e67)](https://camo.githubusercontent.com/268df3a46dcee0ecf23a93d496d5be0e862c3026fc70d8ef77c2ec55d3af528f/68747470733a2f2f646f63732e617069646f632e6963752f6c6f676f2e706e67)

 Apidoc
========

[](#--apidoc)

 基于PHP的注解生成API文档及Api接口开发工具

[![](https://camo.githubusercontent.com/a2dd63843a0083bb13e7ba583b98af7247deb0f5594e7369afd1a4026b22ac7a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f68672f617069646f63)](https://packagist.org/packages/hg/apidoc)[![](https://camo.githubusercontent.com/41cef39ba980fdca314ffb1ac412e7182957dead120d42ffb0bed31da4f721b1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f68672f617069646f63)](https://packagist.org/packages/hg/apidoc)[![](https://camo.githubusercontent.com/d7c5a76e70786b646b734c4321acd820c7adc1bf9757f8ecb699015972285699/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f68672f617069646f63)](https://packagist.org/packages/hg/apidoc)[![](https://camo.githubusercontent.com/2fa3cfbe33445bef501d714a1e1b16a8dec83f323ecf232d58573c4add3fe37a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64642f68672f617069646f63)](https://packagist.org/packages/hg/apidoc)[![](https://camo.githubusercontent.com/bc5f8472863383705d29e5994289fbf3e8b5cb770899018ddcb6686b52330013/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f68672f617069646f63)](https://packagist.org/packages/hg/apidoc)[![](https://camo.githubusercontent.com/1639c9e03fa9e32284ceee5a68f185f60e6b86da5fc3d6cda03a9b0fc422707f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f4847746865636f64652f617069646f632d706870)](https://github.com/HGthecode/apidoc-php)[![](https://camo.githubusercontent.com/ed7893da539811ca2c808af297a8248c182c24e5bee6659e02d94b3bd335245c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f4847746865636f64652f617069646f632d706870)](https://github.com/HGthecode/apidoc-php)

🤷‍♀️ Apidoc是什么？
---------------

[](#‍️-apidoc是什么)

Apidoc是一个通过解析注解生成Api接口文档的PHP composer扩展，兼容Laravel、ThinkPHP、Hyperf、Webman等框架； 全面的注解引用、数据表字段引用，简单的注解即可生成Api文档，而Apidoc不仅于接口文档，在线接口调试、Mock调试数据、调试事件处理、Json/TypeScript生成、接口生成器、代码生成器等诸多实用功能，致力于提高Api接口开发效率。

✨特性
---

[](#特性)

- 开箱即用：无繁杂的配置、安装后按文档编写注释即可自动生成API文档。
- 轻松编写：支持通用注释引用、业务逻辑层、数据表字段的引用，几句注释即可完成。
- 在线调试：在线文档可直接调试，并支持全局请求/Mock参数/事件处理，接口调试省时省力。
- 安全高效：支持访问密码验证、应用/版本独立密码；支持文档缓存。
- 多应用/多版本：可适应各种单应用、多应用、多版本的项目的Api管理。
- 分组/Tag：可对控制器/接口进行多级分组或定义Tag。
- Markdown文档：支持.md文件的文档展示。
- Json/TypeScript生成：文档自动生成接口的Json及TypeScript。
- 代码生成器：配置+模板即可快速生成代码及数据表的创建，大大提高工作效率。

📌兼容
---

[](#兼容)

以下框架已内置兼容，可开箱即用

|框架|版本| |-|-|-| |ThinkPHP|5.1、6.x、8.x| |Laravel|8.x、9.x、10.x| |Webman|1.x| |Hyperf|2.x、3.x|

📖使用文档
-----

[](#使用文档)

[https://docs.apidoc.icu](https://docs.apidoc.icu/)

🏆支持我们
-----

[](#支持我们)

如果本项目对您有所帮助，请点个Star支持我们

- [Github](https://github.com/HGthecode/apidoc-php) -&gt; [![Star me on GitHub](https://camo.githubusercontent.com/767a9fdffe35b882e75e7430d4b92a879862bfaee9089ac52018a1d2f01e2263/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f4847746865636f64652f617069646f632d7068703f7374796c653d736f6369616c)](https://github.com/HGthecode/apidoc-php)
- [Gitee](https://gitee.com/hg-code/apidoc-php) -&gt; [![star](https://camo.githubusercontent.com/f3b7e20c841af7d1a14fa00d63b1c5f64e3510065ae3bc5a3abf7324d6189356/68747470733a2f2f67697465652e636f6d2f68672d636f64652f617069646f632d7068702f62616467652f737461722e737667)](https://gitee.com/hg-code/apidoc-php/stargazers)

🌐交流群
----

[](#交流群)

[![QQ群](https://camo.githubusercontent.com/b989e226021a4991f60e7586725baa22f25abf4b6dd663ca2b73bb04f89cd0ea/68747470733a2f2f646f63732e617069646f632e6963752f71712d71756e2e706e67)](https://camo.githubusercontent.com/b989e226021a4991f60e7586725baa22f25abf4b6dd663ca2b73bb04f89cd0ea/68747470733a2f2f646f63732e617069646f632e6963752f71712d71756e2e706e67)

💡鸣谢
---

[](#鸣谢)

[doctrine/annotations](https://github.com/doctrine/annotations)

🔗链接
---

[](#链接)

[ApiDoc UI](https://github.com/HGthecode/apidoc-ui)

[ApiDoc Demo](https://github.com/HGthecode/apidoc-demos)

###  Health Score

13

—

LowBetter than 1% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity19

Early-stage or recently created project

 Bus Factor1

Top contributor holds 98.3% 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://www.gravatar.com/avatar/b3dc4ca538c7997e5d4b8099eb454c8c1d0e09ab2de44c3e875390bbfd55f347?d=identicon)[cathy](/maintainers/cathy)

---

Top Contributors

[![HGthecode](https://avatars.githubusercontent.com/u/36032426?v=4)](https://github.com/HGthecode "HGthecode (57 commits)")[![iayoo](https://avatars.githubusercontent.com/u/29270812?v=4)](https://github.com/iayoo "iayoo (1 commits)")

### Embed Badge

![Health badge](/badges/cathy-apidoc/health.svg)

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

###  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)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

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

PHP wrapper for the Meilisearch API

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

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

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