我需要一个文档准备工具来记录我的泽西休息网络服务

时间:2014-09-18 12:18:13

标签: java api documentation jersey

我想记录我的泽西网络服务我的想法是什么,我想记录我们传递给服务的输入数据以及我们传递给服务的参数,以便文档读者可以理解以更好的方式提供服务。

例如

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

我们的代码是否意味着文档应该包含有关Path Params和输入正文的信息(如果存在其他服务)。

我不知道如何实现这个

1 个答案:

答案 0 :(得分:0)

Swagger是记录Rest完整Web服务的最佳文档工具之一。 check this link