Sails.js + apidocjs + grunt - génération automatique de la documentation - node.js, sails.js, api-doc

"Je suis nouveau dans Sails.js et Node.js et j'ai des problèmes avec la création de documentation pour mon application.

Voici mes pas:

• installé apidoc par: npm install apidoc -g
• module de grunt installé: npm install grunt-apidoc --save-dev
• ajoutée grunt.loadNpmTasks("grunt-apidoc"); à Gruntfile.js au fond
• créé grunt.initConfig déposer et mettre:

apidoc: { myapp: { src: "api/controllers/", dest: "apidoc/" } }

Ensuite, j’essaie d’exécuter plusieurs choses et aucune d’entre elles ne produit la documentation de mon API:

• ascenseur à voiles
• grognement
• grunt default
• noeud app.js

Si je le lance manuellement par apidoc -i api/controllers/ -o apidoc/ cela fonctionne correctement.

Qu'est-ce que je fais mal? Comment faire?

Réponses:

Réponse super tardive!

D'après mon expérience en modifiant le portefeuille d'actifs, vous seriez mieux loti:

1. Installez apidoc et le module Grunt comme dans la question

2. Créez un nouveau fichier dans `tasks / config / apidoc.js:

   module.exports = function (grunt) {
   grunt.config.set("apidoc", {
   myapp: {
   src: "api/controllers/",
   dest: "apidoc/"
   }
   });
   grunt.loadNpmTasks("grunt-apidoc");
   };
   

3. modifier tasks/register/compileAssets.js (ou où vous voulez que la tâche soit exécutée):

   module.exports = function (grunt) {
   grunt.registerTask("compileAssets", [
   "clean:dev",
   "jst:dev",
   "less:dev",
   "copy:dev",
   "coffee:dev",
   "apidoc:myapp" // <-- This will now run every time your assets are compiled
   ]);
   };
   

J'espère que cela aide quelqu'un