如何将搜索条件声明为参数 REST API 方法

Question

URI 看起来像 /api/v2/Employee?filter[search_key]=1234 我想为上述 URI 定义 REST API 方法，但我不知道如何使用 [search_key]

    @Path("/Employee")
    @Produces(MediaType.APPLICATION_JSON)
    @Consumes(MediaType.APPLICATION_JSON)
    public interface EmployeeServices {
    
    
    @GET
    public List<Employee> searchEmployee(@QueryParam("filter") String filter);

}

Answer 1

请澄清您的问题。

您可以通过以下方式将 URL 中提供的路径参数用于您的应用程序：

@GET
@Path("/Employee/{filter}")
@Produces({MediaType.APPLICATION_JSON})
public List<Employee> searchEmployee(@PathParam("filter") String filter){
   //your code
}

如果你想在这里做一些实际的后端处理（创建一个控制器类），那么这应该是一个类而不是一个接口。

如果您真的打算使用@QueryParam，请查看此帖子： When to use @QueryParam vs @PathParam