注意:文档已迁移至以下地址,本文将不再维护
GitHub地址:https://github.com/HGthecode/thinkphp-apidoc 文档地址:https://hgthecode.github.io/thinkphp-apidoc/ 示例地址:https://apidoc.demo.hg-code.com/apidoc/
在安装本插件时,默认你已成功安装ThinkPHP6的项目并成功运行。
安装插件
进入ThinkPHP6 项目根目录,执行如下命令:composer require hg/apidoc
添加路由
将 vendor/hg/apidoc/route/apidoc.php
复制到项目目录route
目录下
添加前端页面
1、执行以下命令下载UIgit clone https://github.com/HGthecode/apidoc-ui.git
2、下载完成后,找到dist目录,将该目录放到你的项目public目录下,并将dist文件夹名,重命名为 apidoc
浏览器访问
打开浏览器访问 http://你的域名/apidoc/
如出现以下页面,表示安装成功,就可以开始愉快的编写注释了