java - 将 @PathParams 与 PUT REST Api 结合使用

Question

我正在创建一个 REST 服务，并且我有以下 API -

    @PUT
    @Path("/delete/{teamName}")
    @Consumes(MediaType.TEXT_PLAIN)
    @Produces(MediaType.TEXT_PLAIN)
    public Response delete(@PathParam("teamName")String teamName) {
        if (db.delete(teamName)) {
            return Response.status(200).build(); 
        }
        return Response.status(400).build();
    }

此 API 接受 PathParam 来删除团队名称。这是一个 PUT 调用。我的问题是 -

1. 在 PUT 调用中使用 @PathParams 是一个好的做法吗？

2. 优点和缺点是什么？

Answer 1

可以在任何类型的 RESTful API 资源处理程序中使用 PathParam。但是，PUT 方法在这里不适合，因为它违反了基本的 REST 原则。

REST 假设特定的 HTTP 方法(如 PUT、GET、DELETE、POST)对应于需要对数据执行的特定操作。例如，如果要检索数据，则需要使用GET，而删除数据则需要使用DELETE。

在你的具体情况下，我会选择类似的东西

DELETE /teams/{teamName}

我建议您至少确认Use RESTful URLs and actions更好地理解基本的 REST 原则。