1.项目根目录执行命令

composer require hg/apidoc

(注:可能会出现composer报错的情况,根据报错情况解决,例如fileinfo扩展未安装,版本不符等)

2.根目录下执行命令

php artisan vendor:publish --provider="hg\apidoc\providers\LaravelService"

生成对应的配置文件apidoc.php,文件在config目录下

配置中apps配置的就是自动生成接口的扫描路径(为真实目录,不是命名空间),单应用写一个即可,多应用就写多个,如图中的api和admin

如果一个应用下又有多个目录或应用需要,则就在每个配置下再写几个数组,如下图 

 还可以在配置中写入全局响应,配置完成后,只需在每个接口的注解中写不同的返回信息即可

3.下载前端文件(官网下载即可),下载完成后将解压的文件放入项目pulic目录下即可

4.访问 域名/public/apidoc若出现apidoc画面则表示配置完成

5.每个接口写完后写上对应的注解即可自动生成文档

导出文档

文档生成后需要导出,导出需要用到npm(可参考linux下的npm安装_only°夏至besos的博客-CSDN博客_linux安装npm)

补充说明:可能node也需要更新,之前12的版本会报错,更新到18就好了,更新方法参考(在Linux系统上更新Node.js到最新版本的3种方法_1188啦的博客-CSDN博客_linux 升级node)

1.安装apidoc,在项目执行命令npm install apidoc -g

2.每次导出接口文档都必须要让apidoc读取到apidoc.json文件(如果未添加配置文件，导出报错)，你可以在你项目的根目录下添加apidoc.json文件，这个文件主要包含一些项目的描述信息，比如标题、简短的描述、版本等，你也可以加入一些可选的配置项，比如页眉、页脚、模板等。

{
  "name": "系统接口文档",
  "version": "0.0.1",
  "description": "文档总描述",
  "title": "器自定义标题",
  "url" : "http://swool.chenyang.shop"
}

3.导出到指定位置,命令

apidoc -i ./application -o ./public/apidoc

-i指定扫描哪个文件夹,-0说明导出文档到哪