2.11. 请求你的 API

优质
小牛编辑
131浏览
2023-12-01

使用 Postman

向您的API发出请求非常简单。最好的办法就是使用类似 Postman 的工具。

因为我们不是在URL里面对API进行版本控制,所以我们需要定义一个 Accept 头信息来请求我们的特定版本。header 的格式是这样的:

Accept: application/vnd.YOUR_SUBTYPE.v1+json

在上面的事例中,您将替换 YOUR_SUBTYPE 为您在配置中定义的子类型名称。同样,这通常是您运用程序中独特的东西,例如:它的名称和标识符,通常都是小写字母。

请记住,如果您使用的是不同的标准,例如 x, 那么您最好替换xvnd

在子类型名称之后,我们有我们想要的版本。在上面的例子中, 我们定义v1为我们的API 。然后是一个加号和所需要的格式。如果格式无效,软件包将尝试使用您在配置定义的默认格式。

使用 CURL

如果您不想使用 Postman 。 您可以使用命令行工具, 例如 Curl

$ curl -v -H "Accept: application/vnd.YOUR_SUBTYPE.v1+json" http://example.app/users

如果您启用了严格模式,并且传递无效的 Accept 头信息 。 Symfony\Component\HttpKernel\Exception\BadRequestHttpException 将抛出异常。