'apidoc' 未被识别为内部或外部命令

Question

我正在使用 nodejs 服务器并尝试生成一些文档。 正如我在这里读到的：http://apidocjs.com/， 我将 apidoc 添加为项目的依赖项并且 运行:npm install 一切顺利，我确实看到了 node_modules/api_doc 目录，但是我似乎无法 运行 apidoc -i myapp/ -o apidoc/ 现在我意识到为了 运行 我需要添加到我的环境变量中apidoc\bin 文件夹的路径但是这个 dosent 对我来说很有意义，因为 npm 安装仅在我当前项目的本地安装，而不是我创建的任何项目的全局安装，我在这里缺少什么以及如何使它工作？ 提前致谢。

Answer 1

apidoc命令放在node_modules/.bin文件夹下。您可以尝试将命令 apidoc -i myapp/ -o apidoc/ 放在 package.json.

中的 npm 脚本下

例如：

"scripts": {
  "start": ...,
  "docs": "apidoc -i myapp/ -o apidoc/",
}

现在可以执行npm run docs来生成文档了。

如果您不想使用 npm 脚本，您应该可以使用 npx apidoc -i myapp/ -o apidoc/ 来生成文档。如果您使用 npm@5.2.0 或更高版本，则默认情况下 npx 可用，或者可以从 here.

安装