yuanbo/apidoc
Composer 安装命令:
composer require yuanbo/apidoc
包简介
thinkphp API文档自动生成
README 文档
README
ThinkPHP ApiDoc
基于ThinkPHP 根据注释自动生成API接口文档🤷♀️ Apidoc是什么?
如今,前后端分离的开发模式以必不可少,基于ThinkPHP可以很方便的作为后端Api的开发。可是一个Api开发过程中需要快速调试,开发完成后需要给其它开发者对接,这时一个详细的Api文档,就显得特别重要。
大多数开发者可能都是通过各种工具配合来达到这一目的,其各种工具的安装和配置也是繁琐。甚至还有通过word等文本工具手写api文档的,这样的开发效率与可维护性是非常差的。
综合种种Api开发中的痛点,我们专为ThinkPHP开发了Apidoc的扩展插件,本插件可通过简单的注解即可生成Api文档,及帮助开发者提高生产效率的在线调试、快速生成Crud、一键生成整个模块Api等,涵盖Api开发方方面面。
✨特性
- 开箱即用:无繁杂的配置、安装后按文档编写注释即可自动生成API文档。
- 在线调试:在线文档可直接调试,支持设置全局参数,接口调试省时省力。
- 轻松编写:支持公共注释定义、业务逻辑层、数据表字段的引用,几句注释即可完成。
- 安全高效:支持访问密码验证、应用/版本独立密码;支持文档缓存。
- 多应用/多版本:可适应各种单应用、多应用、多版本的项目的Api管理。
- Markdown文档:支持.md文件的文档展示。
- 快速生成Crud:配置+模板即可快速生成Crud接口代码及数据表的创建,大大提高工作效率。
- 控制器分组:更精细化的对控制器接口进行分组展示。
📌兼容
ThinkPHP 5.x
ThinkPHP 6.x
📢 2.6.0版本开始全面兼容TP5了啦~~~
📖使用文档
🏆支持我们
如果本项目对您有所帮助,请点个Star支持我们
💡鸣谢
🔗链接
yuanbo/apidoc 适用场景与选型建议
yuanbo/apidoc 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 437 次下载、GitHub Stars 达 0, 最近一次更新时间为 2021 年 09 月 07 日, 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向: 「markdown」 「apidoc」 「thinkphp」 「接口文档」 「api文档」 「注释生成」 等业务场景。在实际项目中,围绕这些方向常见需要落地的问题包括:接口对接、性能调优、并发安全、与既有框架(Laravel / ThinkPHP / Yii / Webman 等)的兼容适配,以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 yuanbo/apidoc 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 yuanbo/apidoc 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
与 yuanbo/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
这是使用阿里云日志服务sls的thinkphp6.0日志驱动,支持函数计算
用于 thinkphp6 框架上的基于 OCI 的 Oracle 数据库驱动。thinkphp5.1 请使用 1.0 版本
ThinkPHP6分页驱动
Library for generation of OpenAPI v3 documentation
统计信息
- 总下载量: 437
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 0
- 点击次数: 2
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2021-09-07