1 Star 1 Fork 17

庞斌 / thinkphp-apidoc

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

ThinkPHP ApiDoc

基于ThinkPHP 根据注释自动生成API接口文档

🤷‍♀️ Apidoc是什么?

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

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

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

✨特性

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

📌兼容

ThinkPHP 6.x

如需在 ThinkPHP 5.x 版本中使用,请安装 V1.x版本 V1.x版本安装说明

📖使用文档

ThinkPHP ApiDoc V2.x文档

ThinkPHP ApiDoc V1.x文档

🏆支持我们

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

💡鸣谢

ThinkPHP 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.

简介

基于ThinkPHP6 根据注释自动生成API接口文档 展开 收起
PHP
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

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

搜索帮助