文档缓存

2022年11月10日 14:34 小于 1 分钟

# 文档缓存

建议

开发环境中关闭缓存,可方便实时修改查看效果,提升开发效率。正式发布后可开启。

开启缓存后,每次访问接口文档则直接使用缓存数据展示文档,大大提升访问速度,也可在页面右上角切换历史文档。 但当修改了接口注释后,需手动点击接口文档页面右上角的 ReLoad 按钮生成新的文档数据。

配置文件/config/apidoc.php中的cache设置为如下:

// /config/apidoc.php
// 缓存配置
'cache' => [
    // 是否开启缓存
    'enable' => false,
    // 缓存文件路径
    'path'   =>  '../runtime/apidoc/',
    // 是否显示更新缓存按钮
    'reload' => true,
    // 最大缓存文件数
    'max'    => 5,  //最大缓存数量
],
1
2
3
4
5
6
7
8
9
10
11
12

缓存的文件默认生成在 /runtime/apidoc/目录下,如需删除缓存记录,可直接删除该目录下的相应文件即可