javajerseydocumentation

I need a document preparation tool to document my jersey rest webservices

I want to document my jersey web services what my thought is I want to document the input data which we are passing to the service and also the parameters which we are passing to the service, so that the document readers can understand about the services in a better way.

For example:

@GET
    @Produces(MediaType.APPLICATION_JSON)
    @Path("/getuserbyid/{uid}")
    public Response getuserbyid(@PathParam("uid") int id)

Is our code means the document should have to information about the Path Params and input body if present for other services.

I don't have any idea how to implement this.

Solution

  • Swagger is one of the best documenting tool for documenting the Rest full web services. check this link