hg/apidoc-thinkphp 问题修复 & 功能扩展

解决BUG、新增功能、兼容多环境部署,快速响应你的开发需求

邮箱:yvsm@zunyunkeji.com | QQ:316430983 | 微信:yvsm316

hg/apidoc-thinkphp

Composer 安装命令:

composer require hg/apidoc-thinkphp

包简介

thinkphp API文档自动生成

README 文档

README

注意、注意、注意!!!

本项目已迁移至 https://github.com/HGthecode/apidoc-php ,全新Apidoc兼容ThinkPHP、Laravel、Hyperf、Webman等基于Composer的PHP框架,更多实用功能。本项目不再维护,请移步新项目。

ThinkPHP ApiDoc

基于 ThinkPHP 的API接口开发工具

🤷‍♀️ Apidoc是什么?

如今,前后端分离的开发模式以必不可少,基于ThinkPHP可以很方便的作为Api接口的开发。可是一个Api开发过程中需要快速调试,开发完成后需要给其它开发者对接等,这时一个功能全面的Api文档工具,就显得特别重要。

大多数开发者可能都是通过各种工具配合来达到这一目的,其各种工具的安装和配置也是繁琐。甚至还有通过word等文本工具手写api文档的,这样的开发效率与可维护性是非常差的。

综合种种Api开发中的痛点,我们专为ThinkPHP开发了Apidoc的扩展,本插件可通过简单的注解即可生成Api文档,及帮助开发者提高生产效率的在线调试、快速生成Crud、一键生成整个模块Api等,涵盖Api开发方方面面。

✨特性

  • 开箱即用:无繁杂的配置、安装后按文档编写注释即可自动生成API文档。
  • 在线调试:在线文档可直接调试,支持全局参数、Mock调试数据、事件执行,接口调试省时省力。
  • 轻松使用:支持公共注释定义、业务逻辑层、数据表字段等引用,几句注释即可完成。
  • 安全高效:支持访问密码验证、应用/版本独立密码;支持文档缓存。
  • 多应用/多版本:可适应各种单应用、多应用、多版本的项目的Api管理。
  • Markdown文档:支持.md文件的文档展示。
  • 控制器分组:支持控制器多级分组,更精细化管理接口目录。
  • 多语言:可结合TP多语言能力,实现接口文档的语言切换。

📌兼容

ThinkPHP 5.1

ThinkPHP 6.x

📖使用文档

ThinkPHP ApiDoc V3.x文档

🏆支持我们

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

💡鸣谢

ThinkPHP

doctrine/annotations

🔗链接

ApiDoc UI

ApiDoc Demo

hg/apidoc-thinkphp 适用场景与选型建议

hg/apidoc-thinkphp 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 1.89k 次下载、GitHub Stars 达 129, 最近一次更新时间为 2022 年 11 月 07 日, 在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向: 「markdown」 「apidoc」 「thinkphp」 「接口文档」 「api文档」 「注释生成」 等业务场景。在实际项目中,围绕这些方向常见需要落地的问题包括:接口对接、性能调优、并发安全、与既有框架(Laravel / ThinkPHP / Yii / Webman 等)的兼容适配,以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 hg/apidoc-thinkphp 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。

围绕 hg/apidoc-thinkphp 我们能提供哪些服务?
定制开发 / 二次开发

基于 hg/apidoc-thinkphp 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ:316430983 微信:yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

统计信息

  • 总下载量: 1.89k
  • 月度下载量: 0
  • 日度下载量: 0
  • 收藏数: 129
  • 点击次数: 11
  • 依赖项目数: 0
  • 推荐数: 0

GitHub 信息

  • Stars: 129
  • Watchers: 2
  • Forks: 26
  • 开发语言: PHP

其他信息

  • 授权协议: MIT
  • 更新时间: 2022-11-07