使用API​​ Platform捆绑包的自定义Symfony Action

Question

我尝试使用Symfony捆绑包API-Platform构建API 。

Api资源使用HTTP动词POST，GET，PUT，DELETE提供自动CRUD操作。

我想要的是添加一个端点来处理自定义POST操作，并具有自定义的有效负载/主体，而不依赖于任何资源。

我阻止的地方是将此端点添加到自动API平台文档中。

在GitHub上寻找此类问题时，我发现API平台v2应该可以做到。

请参阅问题385：自定义操作+ ApiDoc

似乎有些人找到了使用NelmioApiDoc @ApiDoc批注的方法。

请参阅问题17：自定义操作的文档

Answer 1

不能使用@ApiDoc注释，将在API Platform 3中删除对NelmioApiDoc的支持，以支持内置的Swagger / Hydra。

如果您使用自定义API平台操作，则该操作应自动记录在Swagger和Hydra文档中。

无论如何，您始终可以自定义Swagger（和Hydra）文档以添加自定义端点或其他任何内容：https : //github.com/api-platform/docs/blob/master/core/swagger.md#override-swagger-documentation（此文档将很快在网站上提供）。