Hi
On 07/12/11 16:35, Steve Karlovic wrote:
Thanks for the response Sergey. I will try out using beans for parameters.

If I want to describe two possible responses for 200 OK, for example an
error message (based on a ResponseError bean) and another with actual
results (based on a ResponseResult bean). Is there a way I can annotate the
interface or implementation class to have the WADL generator capture
response definition as well? Do you have any examples of how to do this?

My goal is to have the WADL generator produce the document to fully
describe the resource including the error responses.

The only way of doing at the moment is to create a WADL manually and refer to it using @docLocation attribute:
http://cxf.apache.org/docs/jaxrs-services-description.html#JAXRSServicesDescription-ExternalWADLdocumentsandJAXRSendpoints.

One option is to have two WADL response elements with single representation each, woth every representation referring to relevant elements in a grammar section;

Another option is to have a single response with two representations;

Yet another: single response with single representation referring to a schema element with a complex type offering a choice

I hope that this will be standardized upon in the future

Cheers, Sergey

Thanks,
Steve

On Wed, Dec 7, 2011 at 2:25 AM, Sergey Beryozkin<[email protected]>wrote:

Hi

On 07/12/11 00:42, Steve Karlovic wrote:

Hello,
How can I have the WADL generator produce and describe which endpoints
throw exceptions? Also, I would like definition of the exception
represented in the same WADL where the response and request objects can be
found if possible.


The older versions of WADL did have a 'fault' element apparently,
something I can see in the old Rackspace WADL, but 'fault' is gone now and
one can list different HTTP error statuses (most of them are not expected
to get the (error) responses accompany them).

Say you have a case where a successful query returns some XML but you
prefer a query with no matching results to return some XML describing why
it happened, with 200 OK, instead of an empty 404. I think in this case a
schema element needs to have a complex choice content.



  If I want to have the WADL generator describe query parameters accepted
resource method, would I need to have these parameters injected using
@QueryParam("someParameter")? If a resource method has a lot of query
parameters is there a another way than having them all in the signature
and
still have query parameters be described in the WADL?

Not sure if this has been worked on at all in recent releases. I am using
2.2.12 still.

  CXF supports query beans:
http://cxf.apache.org/docs/**jax-rs-basics.html#JAX-**
RSBasics-DealingwithParameters<http://cxf.apache.org/docs/jax-rs-basics.html#JAX-RSBasics-DealingwithParameters>

with QueryParam("") extensions, such beans can capture many parameters and
will be described in the generated WADL

Cheers, Sergey


  Any help which can be provided is appreciated.

Thanks,
Steve



--
Sergey Beryozkin

Talend Community Coders
http://coders.talend.com/

Blog: http://sberyozkin.blogspot.com




--
Sergey Beryozkin

Talend Community Coders
http://coders.talend.com/

Blog: http://sberyozkin.blogspot.com

Reply via email to