Adding description to RestEasy's web service parameters?

Question

Is there some way/annotation by which I can add the description to the parameters of a RestEasy web service? I went through the api-doc of the annotations, but found nothing there.

This is in order to add the descriptions so that they are reflected in the REST API documentation which I'll be auto-generating using some tool.

An example web service interface:

@Path("list-all")
@GET
@RBAC(type = { CRUDEnum.READ }, capability = { "PowerUser" })
@ParseContext
@Produces( {
        "application/json",
        "application/xml"})
public net.myapp.services getAllDevices(
        @QueryParam("start") int param0, @QueryParam("limit") int param1);

Ravindra S · Accepted Answer · 2011-10-21 16:46:01Z

1

Found the way for this. There is no REST annotation to add the parameter description.

The solution for this is to use the typical java-doc annotation.

e.g.

/** 
 * @param param0 Paging parameter
 * @param param1 Paging parameter
 * */
@Path("list-all")
@GET
@RBAC(type = { CRUDEnum.READ }, capability = { "PowerUser" })
@ParseContext
@Produces( {
        "application/json",
        "application/xml"})
public net.myapp.services getAllDevices(
        @QueryParam("start") int param0, @QueryParam("limit") int param1);

answered Oct 21, 2011 at 16:46

Ravindra S

6,48212 gold badges74 silver badges111 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Adding description to RestEasy's web service parameters?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related