«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/ в скрипт npm в вашем package.json.

Например:

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

Теперь вы можете выполнить npm run docs для генерации документации.

Если вы не хотите использовать скрипт npm, вы можете использовать npx apidoc -i myapp/ -o apidoc/ для генерации документации. npx доступно по умолчанию, если вы используете npm@5.2.0 или выше, или может быть установлено с здесь .