enunciate
enunciate copied to clipboard
generate Mashery iodocs JSON
Mashery iodocs is a great way to document and provide sample invocation of REST services. It is nice because it is technology agnostic (node.js server/app that derives its information from JSON configuration files about the services).
The thinking was to make a new module/artifact for output from Enunciate that generates JSON configus in the iodocs format. This would allow easy integration and best of both worlds in my opinion. I have applications in various technologies and like iodocs for it's agnostic approach, but for my 75% heavy java community want them to use Enunciate for overall service stack and would like comments/information to flow clear through top to bottom.
IODocs General Info - http://mashery.com/solution/iodocs GITHUB - https://github.com/mashery/iodocs Example JSON - https://github.com/mashery/iodocs/blob/8e408c2a33d63f17c4eea9228b8890f2980c735a/config.json.sample
We might have an alternative as well Ryan. We're looking into contributing an enhancement to iodocs that would allow it to remotely parse a WADL file and translate to it's JSON configs. Since Enunciate generates WADL with documentation references throughout it that come from the relevant javadoc levels, that might turn into great fit for Enunciate since it already does it and also work for other languages/frameworks that either generate a WADL or people how create a WADL manually.
Thanks for the request.
This enhancement is currently seeking a sponsor. If anybody is willing to sponsor the work, reach out to me and I'd be happy to pick it up.