介绍

2022年8月26日 06:05 指南 大约 2 分钟

# 介绍

提示

如果你在使用过程中遇到了 bug,可以 提一个 issue (opens new window)

# 🤷‍♀️ Apidoc是什么?

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

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

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

# ✨特性

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

# 📌兼容

ThinkPHP 5.1

ThinkPHP 6.x

# 🏆支持我们

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

# 💡鸣谢

ThinkPHP (opens new window)

doctrine/annotations (opens new window)

VuePress主题:vuepress-theme-hope (opens new window)