4

使用 Symfony2、FOSRest 和 Doctrine 构建了一个 API。给定以下路线：

"GET /api/path/to/product"

以及以下参数：

[("vendorID", 10), ("destination", "tanzania"), ("type", "accommodation"), ("sort", "price", "ASC")]

使用 FOSRest 捆绑可以检索这些字符串，但是，将它们映射到原则查询是挑战出现的地方。

我考虑过使用为查询字符串的不同组合定制的大量案例语句，而不是一个优雅的解决方案。想要构建一个不会严重影响性能的更通用的控制器。任何建议都会有所帮助。

4

1 回答 1

7

FOSRestBundle 有一个非常酷的param fetcher listener。使用它，您可以使用注释定义查询字符串参数，是否允许它们为空，设置默认值，定义要求。根据您的示例参数，我猜到了一些值

/**
 * @QueryParam(name="vendorID", requirements="\d+", strict=true, description="vendor id")
 * @QueryParam(name="destination", nullable=true, description="restrict search to given destination")
 * @QueryParam(name="type", nullable=true, description="restrict search to given type")
 * @QueryParam(name="sort", requirements="(price|foo|bar)", default="price", description="sort search according to price, foo or bar")
 * @QueryParam(name="dir", requirements="(ASC|DESC)", default="ASC", description="sort search ascending or descending")
 */
 public function getProducts(ParamFetcher $paramFetcher)
 {
     $vendorID = $paramFetcher->get('vendorID');
     // and so on
 }

对于构建查询构建器，使用具有默认值的参数非常简单，因为它们永远不会被未定义的值填充。对于严格的参数，这也没有问题，因为400 Bad Request如果它丢失或不符合要求，严格的参数会引发 a。只有使用可为空的参数，您才必须在将条件添加到查询构建器之前检查 not null。

顺便提一句。看看NelmioApiDocBundle，它为每个动作生成@ApiDoc一个很好的文档注释。它还解析参数获取器注释。非常便利。

于 2013-07-01T12:19:45.197 回答