V2.x升级V3.x指南

由于V3.0是不向下兼容的重构版本，如从V2.x升级到V3.0可参考本文进行升级

升级扩展至3.0

项目根目录执行

composer update hg/apidoc

更新前端文件

前往下载最新版本前端文件：Apidoc UI v2.x

调整配置

提示

由于之前安装过2.x生成过该配置文件了，升级后该配置文件不会重新生成

可将 /vendor/hg/apidoc/src/config.php 的内容拷贝到原config/apidoc.php中，并参考配置参数进行配置

主要调整配置有如下几点：

apps的配置

v2.x中全局配置的groups与controllers；在v3.x版本中，归属到指定应用/版本中，结构更清晰。如下例子

docs的配置

v2.x中通过docs.menu_title指定文档目录标题，与docs.menus配置文档菜单；在v3.x版本中，只需直接通过二维数组定义文档菜单即可

废除的配置项

以下参数为v2.x版本中的配置参数，在v3.x版本中均已废除

配置项	说明
copyright	文档首页显示的版权信息
groups	控制器分组；已移到apps中配置，参考apps的配置
controllers	解析指定的控制器；已移到apps中配置，参考apps的配置
filter_controllers	过滤不解析的控制器；已改为无任何apidoc注解就不会解析，或添加NotParse注释
cache.path	缓存存储路径；已改为tp自带缓存，无需配置
cache.max	缓存存储最大数量；已改为tp自带缓存，无需配置
controller_auto_search	多级路由自动生成url的分割符，已改为通过配置auto_url实现
auto_url_rule	自动生成url的首字母规则，已改为通过配置auto_url实现
docs.menu_title	文档菜单标题；docs配置参考docs的配置
docs.menus	文档菜单；docs配置参考docs的配置