Hi Everyone,
Having been using Jersey for a while now (and I'm a big fan)... I've
been wondering if there has been any consideration for a way to generate
web API documentation, in a similar way to how Javadoc works, which can
be published to the web API consumers?
At the moment I'm manually crafting API documentation and shipping this
to my clients, however the engineer in me tells me that this is a
process that could be automated in some way so that each build of my
software could generate the latest documentation for the web API.
Before sending this I had a hunt around to see if there was anything on
this topic and couldn't spot anything. I apologise if I'm missing it in
my searches though...
I have some ideas how this could work and what would need to be
considered, and I'm seriously thinking of building some
tools/annotations etc which would allow me to achieve this in my own
product, but before I go ahead and do this would like to see if this is
something that the Jersey/JSR-311 community have considered or even have
on a roadmap?
Many thanks and very best wishes,
-Andy
Andy Latham
Senior Solutions Consultant
Talis Information Ltd
Web:www.talis.com <
http://www.talis.com>
Please consider the environment before printing this email.
Find out more about Talis at www.talis.com
shared innovationTM
Any views or personal opinions expressed within this email may not be those of Talis Information Ltd or its employees. The content of this email message and any files that may be attached are confidential, and for the usage of the intended recipient only. If you are not the intended recipient, then please return this message to the sender and delete it. Any use of this e-mail by an unauthorised recipient is prohibited.
Talis Information Ltd is a member of the Talis Group of companies and is registered in England No 3638278 with its registered office at Knights Court, Solihull Parkway, Birmingham Business Park, B37 7YB.