12 Star 138 Fork 17

HG / thinkphp-apidoc

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

注意、注意、注意!!!

本项目已迁移至 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

MIT License Copyright (c) 2021 HG Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

ThinkPHP 注释自动生成API文档,在线调试,代码生成器,Markdown文档 展开 收起
PHP
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
PHP
1
https://gitee.com/hg-code/thinkphp-apidoc.git
git@gitee.com:hg-code/thinkphp-apidoc.git
hg-code
thinkphp-apidoc
thinkphp-apidoc
master

搜索帮助