如何使用多级资源编写java jersey REST API？

Question

我想编写一个多级的 REST API，例如：

/country
/country/state/
/country/state/{Virginia}
/country/state/Virginia/city
/country/state/Virginia/city/Richmond

我有一个 java 类，它是带有 @Path("country") 的 Country 资源

如何创建 StateResource.java 和 CityResource.java 以便我的 Countryresource 可以使用StateResource 以我计划的方式使用它？关于如何在 Java 中构造此类东西的任何有用链接？

Answer 1

CountryResource 类需要有一个使用 @Path 注释到子资源 CityResource 的方法。默认情况下，您负责创建 CityResource 实例，例如

@Path("country/state/{stateName}")
class CountryResouce {

    @PathParam("stateName")
    private String stateName;

    @Path("city/{cityName}")
    public CityResource city(@PathParam("cityName") String cityName) {
        State state = getStateByName(stateName);

        City city = state.getCityByName(cityName);

        return new CityResource(city);
    }

}

class CityResource {

    private City city;

    public CityResource(City city) {
        this.city = city;
    }

    @GET
    public Response get() {
        // Replace with whatever you would normally do to represent this resource
        // using the City object as needed
        return Response.ok().build();
    }
}

CityResource 提供处理 HTTP 动词的方法（在本例中为 GET）。

您应该查看有关子项目的 Jersey 文档 - 资源定位器以获取更多信息。

另请注意，Jersey 提供了 ResourceContext 获取it来实例化子资源。如果您要在子资源中使用 @PathParam 或 @QueryParam 我相信您需要使用它，因为运行时在创建时不会触及子资源您自己通过new。