Api 平台-从外部返回数据 API

Question

我目前正在使用 API 平台来显示 Elasticsearch 中的一些数据。这工作正常，但我现在有另一个正在查看的功能。

我的应用程序需要处理需要到达端点并返回一些数据的第 3 方 API。

在我的应用程序中，我希望能够点击（ /api/logistics/{action} - 其中动作是一个端点，例如登录）然后点击我的应用程序层并返回数据（第 3 方可以重新-命名）

给第 3 方的 API 调用没问题，但我不确定如何显示响应。

我看过https://api-platform.com/docs/core/data-providers/看起来我可以创建自定义响应。

我还需要创建一个实体/模型并使用使用我的数据提供程序的 controller 配置@ApiResource()吗？

如果是这样，那么我需要在注释中添加什么，因为我没有id标识符

我是 API 平台的新手，之前没有使用过数据提供程序功能

我不会存储来自第三方 API 的数据，只是调用 HTTP，检索响应并希望通过 Api 平台显示它

谢谢

Answer 1

您对数据提供者的看法大多是正确的。 但正如文档页面一般设计注意事项所述，“您必须编写一个普通的旧 PHP object (POPO) 代表您的端点的输入和 output。这是标有 @ApiResource 注释的 class。这个 class 没有必须映射到 Doctrine ORM 或任何其他持久性系统。”

所以不，它不需要是一个实体，但必须有一个标有 @ApiResource 注释的 class（但将它放在 Entity 文件夹中可能有助于使 @ApiResource() 标记起作用 - 或者添加你的文件夹class 在 api/config/packages/api_platform.yaml 中）。

对于项目“获取”端点，您的 POPO 需要一个 ID。 属性 - 或者如果只有一个 getter，则 getter - 必须用 @ApiProperty(identifier=true) 标签标记。 通常最简单的方法是对外部 api 调用的响应中的一些字符串进行内爆/编码，这些字符串对于响应来说是唯一的并且不会改变。 您的数据提供者将不得不分解/解码 id 并使用组件进行外部 api 调用。

对于“post”操作，您需要一个datapersister而不是 dataprovider。 Apip 将实例化并填充您的 POPO 并将其传递给 datapersister，您可以从那里调用外部 api 并返回 object 作为结果。 如果您的 object 不是同一类型的 POPO，您应该指定 "output"=TheOutputClass::class 或将操作放在 output class 上并指定 "input"=TheInputClass::class（将 TheOutputClass98 替换为实际的 18295 或 TheInputClass8 名称）

对于“put”和“patch”，您需要一个数据提供者、一个数据持久化者和一个 ID。 它们可以有不同的输入和 output 类，请参阅有关 DTO 的文档。

使用方法“get”的集合操作可能看起来很方便，因为您可以将任何查询字符串传递给它，但您的 CollectionDataProvider 必须返回一个可迭代对象。