It looks great to me Francesco! It'll be a huge plus for the project to have such documentation available IMO.
Colm. On Tue, Oct 22, 2013 at 3:06 PM, Francesco Chicchiriccò <[email protected] > wrote: > Hi all, > I am currently working on SYNCOPE-151 and trying to get some automatically > generated documentation for Syncope core RESTful services. > > After some discussion at cxf-user ML [1], I finally decided to develop > some XSL stylesheets for transforming the WADL [2] file generated by CXF > into some browseable HTML output; you can browse a demo of Apache Syncope > 1.2.0-SNAPSHOT API at [3]; consider that only /users has been documented > via CXF annotations so far. > > Basically, a couple of XSL stylesheets (one for schema, one for resources) > takes the application.wadl generated by CXF as input and > generates some HTML pages, with some jQuery spice. > > The demo above was statically generated from a Cocoon 3 web application; > the project is hosted at [4] > > I've started with a pure Cocoon 3 webapp because it was faster for me to > proceed this way, but I'll make soon a servlet doing the same job - and > I'll add that to Syncope, for live WADL rich browsing. > > WDYT? > Naturally, I'm definitely not a frontend specialist, so if anyone wants to > improve the end-user experience, any help is greatly appreciated. > > Regards. > > [1] http://cxf.547215.n5.nabble.**com/WADL-documentation-via-** > Javadoc-td5735089.html<http://cxf.547215.n5.nabble.com/WADL-documentation-via-Javadoc-td5735089.html> > [2] https://wadl.java.net/ > [3] > http://people.apache.org/~**ilgrosso/wadl2html/<http://people.apache.org/~ilgrosso/wadl2html/> > [4] https://github.com/Tirasa/**wadl2html<https://github.com/Tirasa/wadl2html> > > -- > Francesco Chicchiriccò > > ASF Member, Apache Syncope PMC chair, Apache Cocoon PMC Member > http://people.apache.org/~**ilgrosso/<http://people.apache.org/~ilgrosso/> > > -- Colm O hEigeartaigh Talend Community Coder http://coders.talend.com
