Yii2 apidoc 不允许我将我的项目和 yii 框架添加到同一个文档中。

Question

我正在使用 yiisoft/yii2-apidoc (#0.2.4) 为在 yii2 中编写的项目构建文档。我已经构建了一个 shell 脚本来发布文档，当我只包含项目文件和我自己的 cms 代码库时，它可以正常工作，这些代码库是通过 Composer 引入的。

这是代码

 #!/bin/sh

VENDOR="../vendor"

# remove existing docs
rm -rf ./frontend/web/docs

# create new docs, by drawing in all prroject code and TiCMS code. exclude the docs themselves.
$VENDOR/yiisoft/yii2-apidoc/apidoc api ./,$VENDOR/toruinteractive/ti-cms ./frontend/web/docs --interactive=0  --exclude="./frontend/web/docs"

所以这会生成包含我列出的所有代码的文档......



但是当我添加 yii 框架时问题就来了——我需要它来显示我的代码继承的方法和参数。所以添加了 yii2 框架的新代码是......

#!/bin/sh

VENDOR="../vendor"

# remove existing docs - this is needed as it sometimes doesn't exclude the docs folder and the output then gets cached.
rm -rf ./frontend/web/docs

# create new docs, by drawing in all prroject code and TiCMS code. exclude the docs themselves.
$VENDOR/yiisoft/yii2-apidoc/apidoc api ./,$VENDOR/toruinteractive/ti-cms,$VENDOR/yiisoft/yii2 ./frontend/web/docs --interactive=0  --exclude="./frontend/web/docs"

这会生成带有 的文档仅 列出的 yii2 代码 - 我所有的类(class)都消失了(见下面的截图)。我看不到我在这里做错了什么，有人可以帮忙吗？

Answer 1

您遇到了与 yiisoft/yii2 #7789 中描述的相同的问题并作为 Yii developer replied , apidoc 命令现在是用于 Yii 框架文档的。

如果你还想使用它，你必须排除Yii框架所在的目录。假设它是 ./vendor/yiisoft ，那么排除选项将是

--exclude="./frontend/web/docs,./vendor/yiisoft"

通过检查 BaseController.php和 ApiController.php ，可以看到整个 vendor和 tests仅当未提供排除选项时，目录才会被忽略。由于您提供了排除选项，因此不会使用默认排除。

如果您想知道为什么包括 vendor/yiisoft目录会导致问题，你需要研究apidoc扩展中的细节，特别是 bootstrap template在你的情况下。