hg/apidoc
Composer 安装命令：
composer require hg/apidoc
包简介
根据注解生成API文档，兼容Laravel、ThinkPHP、Hyperf、Webman等框架；在线调试、Markdown文档、多应用/多版本、Mock数据、授权访问、接口生成器、代码生成器等众多实用功能
README 文档
README
Apidoc
基于PHP的注解生成API文档及Api接口开发工具🤷♀️ 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。
- 代码生成器：配置+模板即可快速生成代码及数据表的创建，大大提高工作效率。
- 接口分享：支持自由指定应用/接口生成分享链接、导出swagger.json文件。
📌兼容
以下框架已内置兼容，可开箱即用
| 框架 | 版本 | 说明 |
|---|---|---|
| ThinkPHP | >=5.1 | |
| Webman | >=1.x | |
| Laravel | >=8.x | 低于 Laravel8 版本未测试，可自行尝试 |
| Hyperf | >=2.x |
📖使用文档
🏆支持我们
如果本项目对您有所帮助，请点个Star支持我们
🌐交流群
💡鸣谢
🔗链接
hg/apidoc 适用场景与选型建议
hg/apidoc 是一款 基于 PHP 开发的 Composer 扩展包，目前已累计 91.52k 次下载、GitHub Stars 达 220， 最近一次更新时间为 2020 年 06 月 04 日， 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向： 「markdown」 「apidoc」 「接口文档」 「api文档」 「注释生成」 「php接口文档」 等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 hg/apidoc 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。
基于 hg/apidoc 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。
与 hg/apidoc 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：
Texy converts plain text in easy to read Texy syntax into structurally valid (X)HTML. It supports adding of images, links, nested lists, tables and has full support for CSS. Texy supports hyphenation of long words (which reflects language rules), clickable emails and URL (emails are obfuscated again
Adds more BBCode
Apidoc文档导出插件
thinkphp API文档自动生成
Library for generation of OpenAPI v3 documentation
Creates a markdown changelog for your GitHub repository.
统计信息
- 总下载量： 91.52k
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 226
- 点击次数： 16
- 依赖项目数： 1
- 推荐数： 0
其他信息
- 授权协议： MIT
- 更新时间： 2020-06-04