thinkphp6.0 使用thinkapidoc,在开启强制路由的情况下如何配置？

Question

我写接口写到一半，发觉整个apidoc方便一些，然后就安装了扩展hg/apidoc ,但是我的tp是开了强制路由的。apidoc跑不起来，有哪位大虾，能解决一下我的问题嘛？

Answer 1

在ThinkPHP 6.0中，使用thinkapidoc生成API文档，并开启强制路由时，需要进行如下配置：

1. 首先，在config/app.php文件中开启强制路由，将url_route_must配置项改为true：

'url_route_must'         => true, 

1. 然后，安装并配置thinkapidoc。在composer.json文件中加入下面的代码，然后执行composer update命令安装依赖库：

"require-dev": {
    "tiderjian/think-apidoc": "^1.0"
}

1. 配置thinkapidoc的参数。在config/app.php文件中添加自定义配置项，如下所示：

return [
    // other configs
    'think\apidoc\ServiceProvider',

    // 自定义配置项
    'apidoc'  => [
        'title'          => '接口文档', // 文档标题
        'version'        => 'v1.0', // 文档版本
        'controller_dir' => 'app\api\controller', // 控制器目录
        'exclude_dir'    => ['base', 'extra'], // 排除的目录
        'output_dir'     => 'public/apidoc', // 生成文档的输出目录
        'theme'          => 'default', // 文档主题
        'suffix'         => '.html', // 文档后缀
        'debug'          => true, // 调试模式
    ],
];

其中，controller_dir是API控制器文件目录，exclude_dir是需要排除的目录，output_dir是文档输出目录，theme是文档主题，suffix是文档后缀，debug是调试模式控制开关。

1. 最后，在命令行中执行php think apidoc命令，生成API文档。在生成API文档前，需要先运行一次php think route:list命令，生成runtime/route.php文件。否则，将无法正确生成API文档。

以上就是在开启强制路由时，使用thinkapidoc生成API文档的配置方法。