leejt489 / sails-apidocs

Automatically generate documentation for a Sails.js API from Sails blueprints and inline code documentation
MIT License
10 stars 4 forks source link

Add restPrefix from blueprint config #2

Open sukharenko opened 9 years ago

sukharenko commented 9 years ago
Wanted33 commented 8 years ago

@sukharenko Do this pull request works with the latest version of sails ?

leejt489 commented 8 years ago

Hi,

Apologies, but I haven't been working on this project for about a year. I keep meaning to get to it, but it gets pushed back, and I'm not actively using it. If someone wants to take over the repository that would be great.

On Wed, Apr 27, 2016 at 1:20 AM, Quentin Rubini notifications@github.com wrote:

@sukharenko https://github.com/sukharenko Do this pull request works with the latest version of sails ?

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/leejt489/sails-apidocs/pull/2#issuecomment-215008174

sukharenko commented 8 years ago

@Wanted33 Should works. I make this change few months ago and it was working good.

maxiejbe commented 8 years ago

@sukharenko Thanks for the PR! I was able to generate blueprints docs.

I still cannot generate docs for:

Custom routes

config/routes.js

Example:

  '/': {  
    controller: 'AvailabilityController',  
    action: 'check',  
  },

Model attributes

api/models/*.js

Example:

/**
* Province.js
*
* @description :: Province description
*/

module.exports = {

  attributes: {
    name: {
      type: 'string',
      required: 'true',
    }
  }
};

Custom controller methods

api/controllers/*.js

Example:

/**
 * AvailabilityController
 *
 * @description :: Availability controller
 */

module.exports = {
    check: function(req, res){
        return res.ok('Api is available');
    }
};

Could you please provide a few examples about how to format comments on each case to be parsed properly?

Thanks in advance!

Edit 07/18/2016 : Looking at the code realized that it's based on dox. Should we follow that format?