cxf-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Daniel Kulp <>
Subject Re: API for web services
Date Tue, 14 Sep 2010 19:39:01 GMT
On Monday 13 September 2010 2:16:21 pm Eric MacAdie wrote:
> We are making a REST API at our company, and we need to provide
> documentation. Are there any standards for documenting REST APIs?

Well, for "standards" type things, there really is just WADL (supported by CXF 
and Jersey and possibly others) and WSDL 2.0 (possibly just Axis2).  For CXF 
and Jersey, if you have a JAX-RS service, the WADL things can be generated 
> Can
> anybody recommend some API docs to emulate or to avoid? What do people
> think of the docs for some existing web services, like Yelp, Amazon,
> LinkedIn, etc?

Can't really help on that.  Sorry.  :-(


> Thanks for any input.
> Regards,
> Eric MacAdie

Daniel Kulp

View raw message