Laravel安装
- 安装
Laravel安装
在安装本插件时,确保你已成功安装Laravel的项目并成功运行
安装方法参考:laravel8.x安装文档
1、安装插件
进入项目根目录,执行如下命令:
composer require hg/apidoc
Laravel10
由于Laravel10版本框架内置依赖了doctrine/lexer3.x扩展;而Apidoc为了兼容PHP<8.1.0的环境,约束了doctrine/lexer扩展为^1 || ^2
版本,会导致安装失败。可用以下命令降级doctrine/lexer来安装完成。
# 根目录执行
composer require doctrine/lexer:2.1
2、生成配置文件
项目根目录下执行:
php artisan vendor:publish --provider="hg\apidoc\providers\LaravelService"
命令执行后在将在config
目录下生成apidoc.php
配置文件
3、添加前端页面
下载完成后解压,将apidoc文件夹拷贝到你的项目 public 目录下
打开浏览器访问 http://你的域名/apidoc/ ,出现接口文档页面,表示安装成功。
配置异常响应
由于框架会对全局异常进行处理,如apidoc的异常未被正确响应,会导致页面打不开或报错,配置以下异常处理来解决问题。
// 找到你的项目所配置的异常处理类,默认为
// app/Exceptions/Handler.php
public function register()
{
$this->reportable(function (Throwable $e) {
if ($e instanceof \hg\apidoc\exception\HttpException) {
return abort(
$e->getStatusCode(),
$e->getMessage(),
);
}
});
}