API 平台：更改端点的描述

Question

我使用 API 平台创建了自定义端点。这是我使用的注释：

/**
 * We only want the POST option for now.
 *
 * @ApiResource(
 *      itemOperations={},
 *      collectionOperations={"post"={
 *           "method"="POST",
 *           "controller"=PairingController::class,
 *           "path"="/devices/pairing",
 *           "defaults"={"_api_receive"=false}
 *     }},
 * )
 *
 *
 */
class Pairing
{
...

我调用的控制器执行一些自定义逻辑。我对到目前为止的工作方式感到满意。但是 API 平台生成的文档现在不准确。它说：

/devices/pairing Creates a Pairing resource.

... 这不再正确，因为我的控制器不生成配对。（它调用了另一个 API，要求 API 做一些事情。）

所以这是我的问题：如何更改注释以允许我为此端点编写自定义文档？

Answer 1

您可以使用 swagger_context 键更改任何 Swagger 字段，包括 description（您要查找的那个）：https://api-platform.com/docs/core/swagger/#changing-operations-in-the-swagger-documentation

Answer 2

它对我不起作用，这是我用 openapi_context 做的：

"openapi_context"={
    "summary"="test",
},

API 平台：更改端点的描述

API Platform: Change description of an endpoint

php

annotations

symfony

api-platform.com