无法将“ apidoc”识别为内部或外部命令

Question

我正在nodejs服务器上工作，并试图生成一些文档。 正如我在这里读到的：http://apidocjs.com/， 我已经将apidoc添加为项目的依赖项并运行：npm install 一切正常，我确实看到了node_modules / api_doc目录，但是我似乎无法运行apidoc -i myapp/ -o apidoc/，现在我意识到要运行此命令，我需要将apidoc \ bin文件夹的路径添加到我的环境变量中，但这很重要对我而言，这很有意义，因为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/来生成文档。如果您使用的是npx或更高版本，则npm@5.2.0默认可用，或者可以从here安装。{p>