I haven't used this one, but it looks interesting: https://developers.helloreverb.com/swagger/
It supports multiple platforms, and there is a module for node.js/express: https://github.com/wordnik/swagger-node-express On Wednesday, July 24, 2013 3:23:47 AM UTC-4, JVA wrote: > > Hi all, > > I'm wondering if anyone has tried to generate REST api documentation > (html) based directly to express routes ? > I would be also very interested to hear any comments related how to create > nice & entire REST api documentation. > I've tried find perfect solution but didn't find yet. > > My *requirements*: > -MD support > -html UI > -entire api doc, (all expressjs routes ) > -mongoose schema documentation support directly from schema > -(nice to have) possible to generate single file doc (e.g. pdf/doc/html) > > What I'm tried already (bold words is most critical thing why I didn't > select that library) : > > *apidoc* <https://npmjs.org/package/apidoc> > + MD support > + nice UI > + several comment tag supports > + pluggable > + generate html -> "offline usage" > + versioning > -* no TAC* (table of content) > *this might be possible to do with pluggin? > - needs a lot of comment tags to get good enought doc > - depends on comments how perfect document are > - If mongoose is used in back-end there is no easy way for *document > schemas *(related to REST-api) > *this can be done with pluggin. > > *express-api-docs* <https://npmjs.org/package/express-api-docs> > +routes based > *-no REST style* > * > * > Is there any other libraries ? Currently this apidoc seems to be best > solution for me, > but needs "a lot of" job to get all requirements fulfilled, but there > might be also several limitations... > > Best Regards, > Jussi > -- -- Job Board: http://jobs.nodejs.org/ Posting guidelines: https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines You received this message because you are subscribed to the Google Groups "nodejs" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/nodejs?hl=en?hl=en --- You received this message because you are subscribed to the Google Groups "nodejs" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/groups/opt_out.
