页面500错误
2022年11月10日 14:34 大约 1 分钟
# 页面500错误
访问apidoc页面时，以下原因有可能导致页面显示 500 错误
# 注解错误
项目所有被解析文件的注释中存在 @XXX 的，都需use引入注释解释文件，如出现以下错误
可根据提示在相应的文件里，加上use解释文件
<?php
namespace app\controller;
// 加上这句
use hg\apidoc\annotation as Apidoc;
// 通过use自定义解释文件，解决下面@abc的错误
// use app\utils\Abc;
/**
* @Apidoc\Title("基础示例")
*/
class BaseDemo
{
/**
* @Apidoc\Title("引入通用注释")
* @abc 错误示例，这样不存在解释文件的注释会报错；可增加use解释文件，或去除@
*/
public function test(){
//...
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
自定义解释文件
// app/utils/Abc.php 解释文件内容
<?php
namespace app\utils;
use Doctrine\Common\Annotations\Annotation;
/**
* 自定义参数解释文件
* @package hg\apidoc\annotation
* @Annotation
* @Target({"METHOD","CLASS"})
*/
class Abc extends Annotation
{}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
配置忽略带@的注解报错：
// apidoc.php
[
'ignored_annitation'=>['abc','name']
]
1
2
3
4
2
3
4
# 配置错误
通常是config/apidoc.php的配置项配置错误导致此类错误，配置错一般会在页面提示出具体的错误信息，根据提示检查配置项是否配置正确即可
# ref引入文件不存在
在接口注解时，使用ref引用了一个不存在的文件，也可能出现该错误