ThinkPHP ApiDoc

根据注释自动生成 API 接口文档
授权协议 MIT
开发语言 PHP
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 国产
投 递 者 裴俊豪
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

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支持我们

  • 系统:windows11 集成环境:小皮(原phpstudy) composer:2.5 准备工作:安装小皮后,在软件管理中安装composer,2.3安装不上去,只能安装1.8.5,没关系安装后升级成为新版就可以,安装后记得把composer.phar和composer.bat放到对应的php目录中, composer升级: composer self-update 不明白可以百度一下详细了解。

  • 官方文档: https://hgthecode.github.io/thinkphp-apidoc/ 完结撒花.❀❀❀❀❀❀ TP6版本 安装 composer require hg/apidoc 去官网下载前端页面 https://hgthecode.github.io/thinkphp-apidoc/guide/install/ 下载完成后解压,将apidoc文件夹拷贝到你的项目 publi

  • 一,工具 1,宝塔(由于PHPStudy无法设置运行目录,伪静态之后依然需要加public才能访问,导致后期很多扩展出问题,比如apidoc访问可能会出现404) 宝塔面板 - 简单好用的Linux/Windows服务器运维管理面板 2,phpstorm 3,thinkphp6 轻量级PHP框架|专注WEB应用开发17年 · ThinkPHP 4,apidoc 建议及规范 | ThinkPHP-A

  • thinkphp5-fast-curd 项目介绍 适用于ThinkPHP5(简单、快速的构建CURD) 通过以下代码简单的常规CURD就完成了,接下来就可以去处理前端表单或列表了 ... // 类放置位置 use app\traits\Resources; use app\models\ArticleModel; class Article extends Controller { use Res

  • 一、ThinkPHP的介绍: 基于MVC模式(3者分离) M - Model 模型 工作:负责数据的操作 V - View 视图(模板) 工作:负责前台页面显示 C - Controller 控制器(模块) 工作:描述功能 二、ThinkPHP的获取: http://www.thinkphp.cn 三、ThinkPHP核心文件介绍 : ├─ThinkPHP 框架系统目录(可以部署在非web目录下面

  • 控制器 新建控制器的定义 1/声明命名空间 app\模块\controller 2/控制器文件名首字母大写,采用驼峰命名 3/控制器名和文件名对应 控制器名字采用驼峰命名  那么访问时系统会自动转为全小写 ThinkPhp  用方法 加载页面 1/用系统函数view() 2/用系统类 view中的fecth方法 3/继承系统控制器Controller 用父级方法 fecth 数据的输出 1/字符串

  • Thinkphp 6 + Vue 2 + ElementUI + Vxe-table 前后端分离的,一键生成代码和API接口的,通用后台管理系统 快速开发框架,开发小程序和APP的推荐框架! 概述 RdsAdmin是一款PHP语言开发的,基于Thinkphp 6 + Vue 2 + ElementUI + Vxe-table 等开源框架精心打造的,前后端分离的,一键生成功能菜单的,快速实现API接

  • 解决thinkphp query()执行原生SQL语句成功结果报错的问题 参考文章: (1)解决thinkphp query()执行原生SQL语句成功结果报错的问题 (2)https://www.cnblogs.com/MXubin/p/9468512.html 备忘一下。

  • Thinkphp6框架获取指定模块下控制器,方法及注释信息 经常我们在做项目前后分离情况下需要做后台管理系统用户权限功能,需要扫描控制器下功能块(方法),整理记录下以便后期使用更快捷 直接上代码: 获取指定模块下所有的控制器和方法,注释 /** * 获取指定模块下所有的控制器和方法,注释 */ public function data() {

  • 网址:https://hgthecode.github.io/thinkphp-apidoc/guide/install/#安装插件 1.安装好tp6项目环境 2.添加apidoc扩展:composer require hg/apidoc 3.下载api前端,放到public目录下 4.更改config/apidoc.php配置文件: apps:这个目录设置为接口的目录如: 'apps'

  • 下载swagger-ui:git clone https://github.com/swagger-api/swagger-ui.git 复制swagger-ui目录下dist文件到thinkphp项目public目录下 composer require zircote/swagger-php composer require uniadmin/uniadmin-apidoc dev-master

  • ####1、安装扩展 composer require weiwei/api-doc ####2、配置参数 5.0安装好扩展后在 application\extra\ 文件夹下会生成 doc.php 配置文件 5.1安装好扩展后在 application\config\ 文件夹下会生成 doc.php 配置文件 在controller参数中添加对应的类 ‘controller’ => [ ‘app

 相关资料
  • 问题内容: 如何在Eclipse中自动生成基于xml的函数标头注释(@param等)。在Visual Studio中是否有等效的“ ///”快捷方式。 问题答案: 在方法定义之前的那一行中,键入并按Enter。 在IDE中,在方法前键入,然后按Enter。Eclipse将自动生成Javadoc标记并结束

  • CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档,注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境(cabal.debug配置为true)下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =

  • 本文向大家介绍SpringBoot+Swagger-ui自动生成API文档,包括了SpringBoot+Swagger-ui自动生成API文档的使用技巧和注意事项,需要的朋友参考一下 随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。 这样后段开发好了api 之后就要提交api 文档给前端的朋友。给前端的a

  • 我试图执行一个集成测试,我的类与@Transactional注释不能自动连接到一个测试类与NoSuchBean定义异常。我把它注释出来,检查了一份装载豆子的列表,我的服务就在那里,只是没有注射。 组织。springframework。豆。工厂BeanCreationException:创建名为“com”的bean时出错。icsynergy。西姆。服务DBIntegrationServiceTest

  • 我正在开发一个spring boot应用程序,我遇到了一个问题。我正在尝试注入一个@Repository注释接口,但它似乎根本不起作用。我收到这个错误 实体类: 存储库接口: 控制器:

  • 问题内容: 我正在使用JPA(Hibernate的实现)来注释实体类,以将其持久化到关系数据库(MySQL或SQL Server)。有没有一种简单的方法可以从带注释的类自动生成数据库模式(表创建脚本)? 我仍处于原型制作阶段,并期望频繁的模式更改。我希望能够从带注释的代码中指定和更改数据模型。Grails的相似之处在于它从域类生成数据库。 问题答案: 您可以使用Hibernate中的hbm2ddl

  • 手工编写类和从scheme生成JAXB类的优缺点是什么。我开始新的项目,并希望了解如何选择避免陷阱。 我有复杂的XML结构(基本上是FreeSwitch配置定义),包括不同XML级别上的可重复类型。

  • 我还想在自动生成getter和setter时生成注释 Android Studio: 我想要: