Блог

Я хочу использовать apiDoc для документирования интерфейса WebAPI. В документации apiDoc упоминается использование package.json файла для указания таких вещей, как название проекта и последняя версия API. К сожалению, я не могу заставить это работать. Куда следует поместить этот файл? Я попытался поместить его в папку с документированным кодом, в папку с сгенерированным кодом документации и в папку, из которой вызывается apiDoc, но во всех случаях я получаю сообщение:

 apidoc: No package.json found!
  

Есть ли трюк, который я здесь не нашел?

Поместите его в корневой каталог вашего проекта (где находятся ваши исходные файлы). Запустите apidoc в своем корневом каталоге.

Если вы используете gulp-apidoc or grunt-apidoc , вы можете использовать флаг конфигурации -c , чтобы указать местоположение package.json or apidoc.json . Вот так:

 apidoc({
      src: ["../pathToSrc"],
      dest: "./docs",
      config: "./pathToConfig"
    },done);